Remove all locations string (#781)

* Remove all locations string

* fixes

Author: cbellot000

examples/02-modal-harmonic/01-modal_cyclic.py

@@ -50,14 +50,14 @@
 scyc_op.inputs.time_scoping.connect([8])
 
 # request the results averaged on the nodes
-scyc_op.inputs.requested_location.connect("Nodal")
+scyc_op.inputs.requested_location.connect(dpf.locations.nodal)
 
 # connect the base mesh and the expanded mesh, to avoid rexpanding the mesh
 scyc_op.inputs.sector_mesh.connect(model.metadata.meshed_region)
 # scyc_op.inputs.expanded_meshed_region.connect(mesh)
 
 # request equivalent von mises operator and connect it to stress operator
-eqv = dpf.Operator("eqv_fc")
+eqv = dpf.operators.invariant.von_mises_eqv_fc()
 eqv.inputs.connect(scyc_op.outputs)
 
 # expand the results and get stress eqv
@@ -77,7 +77,7 @@
 scyc_op.inputs.time_scoping.connect([8])
 
 # request the results averaged on the nodes
-scyc_op.inputs.requested_location.connect("Nodal")
+scyc_op.inputs.requested_location.connect(dpf.locations.nodal)
 
 # connect the base mesh and the expanded mesh, to avoid rexpanding the mesh
 scyc_op.inputs.sector_mesh.connect(model.metadata.meshed_region)
@@ -87,7 +87,7 @@
 scyc_op.inputs.sectors_to_expand.connect([1, 3, 5])
 
 # extract Sy (use component selector and select the component 1)
-comp_sel = dpf.Operator("component_selector_fc")
+comp_sel = dpf.operators.logic.component_selector_fc()
 comp_sel.inputs.fields_container.connect(scyc_op.outputs.fields_container)
 comp_sel.inputs.component_number.connect(0)
 
@@ -115,11 +115,11 @@
 # scyc_op.inputs.expanded_meshed_region.connect(mesh)
 
 # request to elemental averaging operator
-to_elemental = dpf.Operator("to_elemental_fc")
+to_elemental = dpf.operators.averaging.to_elemental_fc()
 to_elemental.inputs.fields_container.connect(scyc_op.outputs.fields_container)
 
 # extract Sy (use component selector and select the component 1)
-comp_sel = dpf.Operator("component_selector_fc")
+comp_sel = dpf.operators.logic.component_selector_fc()
 comp_sel.inputs.fields_container.connect(to_elemental.outputs.fields_container)
 comp_sel.inputs.component_number.connect(1)
 

examples/02-modal-harmonic/02-cyclic_multi_stage.py

@@ -28,12 +28,12 @@
 # property with 2 as an argument (1 would ignore the cyclic symmetry).
 
 # Create displacement cyclic operator
-UCyc = model.results.displacement()
-UCyc.inputs.read_cyclic(2)
+u_cyc = model.results.displacement()
+u_cyc.inputs.read_cyclic(2)
 
 # expand the displacements and get a total deformation
-nrm = dpf.Operator("norm_fc")
-nrm.inputs.connect(UCyc.outputs)
+nrm = dpf.operators.math.norm_fc()
+nrm.inputs.connect(u_cyc.outputs)
 fields = nrm.outputs.fields_container()
 
 # # get the expanded mesh
@@ -54,11 +54,11 @@
 SCyc.inputs.time_scoping.connect([3])
 
 # request the results averaged on the nodes
-SCyc.inputs.requested_location.connect("Nodal")
+SCyc.inputs.requested_location.connect(dpf.locations.nodal)
 
 # request equivalent von mises operator and connect it to stress
 # operator
-eqv = dpf.Operator("eqv_fc")
+eqv = dpf.operators.invariant.von_mises_eqv_fc()
 eqv.inputs.connect(SCyc.outputs)
 
 # expand the results and get stress eqv

examples/03-advanced/10-asme_secviii_divtwo.py

@@ -26,11 +26,11 @@
 
 path = examples.download_example_asme_result()
 model = dpf.Model(path)
-dataSource = model.metadata.data_sources
+data_source = model.metadata.data_sources
 
-timeScoping = dpf.Scoping()
-timeScoping.location = dpf.locations.time_freq
-timeScoping.ids = [4]
+time_scoping = dpf.Scoping()
+time_scoping.location = dpf.locations.time_freq
+time_scoping.ids = [4]
 
 
 ###############################################################################
@@ -61,29 +61,29 @@
 # Consequently, a correction factor is applied.
 
 seqv_op = dpf.operators.result.stress_von_mises(
-    time_scoping=timeScoping, data_sources=dataSource, requested_location="Nodal"
+    time_scoping=time_scoping, data_sources=data_source, requested_location=dpf.locations.nodal
 )
 seqv = seqv_op.outputs.fields_container()
 
 s1_op = dpf.operators.result.stress_principal_1(
-    time_scoping=timeScoping, data_sources=dataSource, requested_location="Nodal"
+    time_scoping=time_scoping, data_sources=data_source, requested_location=dpf.locations.nodal
 )
 s1 = s1_op.outputs.fields_container()
 
 s2_op = dpf.operators.result.stress_principal_2(
-    time_scoping=timeScoping, data_sources=dataSource, requested_location="Nodal"
+    time_scoping=time_scoping, data_sources=data_source, requested_location=dpf.locations.nodal
 )
 s2 = s2_op.outputs.fields_container()
 
 s3_op = dpf.operators.result.stress_principal_3(
-    time_scoping=timeScoping, data_sources=dataSource, requested_location="Nodal"
+    time_scoping=time_scoping, data_sources=data_source, requested_location=dpf.locations.nodal
 )
 s3 = s3_op.outputs.fields_container()
 
 strain_op = dpf.operators.result.plastic_strain(
-    data_sources=dataSource,
-    requested_location="ElementalNodal",
-    time_scoping=timeScoping,
+    data_sources=data_source,
+    requested_location=dpf.locations.elemental_nodal,
+    time_scoping=time_scoping,
 )
 pstrain = strain_op.outputs.fields_container()
 

examples/05-plotting/00-basic_plotting.py

@@ -32,7 +32,7 @@
 
 # Plot a field on its supporting mesh (field location must be Elemental or Nodal)
 stress = model.results.stress()
-stress.inputs.requested_location.connect("Nodal")
+stress.inputs.requested_location.connect(dpf.locations.nodal)
 fc = stress.outputs.fields_container()
 field = fc[0]
 field.plot(notebook=False, shell_layers=None, show_axes=True, title="Field", text="Field plot")

examples/05-plotting/02-solution_combination.py

@@ -11,7 +11,7 @@
 """
 
 ###############################################################################
-# Import the ``dpf_core`` module, included examples file, and the ``DpfPlotter``
+# Import the ``ansys.dpf.core`` module, included examples file, and the ``DpfPlotter``
 # module.
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
@@ -35,21 +35,21 @@
 
 ###############################################################################
 # Get the stress tensor and ``connect`` time scoping.
-# Make sure that you define ``"Nodal"`` as the scoping location because
+# Make sure that you define ``dpf.locations.nodal`` as the scoping location because
 # labels are supported only for nodal results.
 #
 stress_tensor = model.results.stress()
 time_scope = dpf.Scoping()
 time_scope.ids = [1, 2]
 stress_tensor.inputs.time_scoping.connect(time_scope)
-stress_tensor.inputs.requested_location.connect("Nodal")
+stress_tensor.inputs.requested_location.connect(dpf.locations.nodal)
 
 ###############################################################################
 # This code performs solution combination on two load cases, LC1 and LC2.
 # You can access individual load cases as the fields of a fields container for
 # the stress tensor.
-field_lc1 = stress_tensor.outputs.fields_container.get_data()[0]
-field_lc2 = stress_tensor.outputs.fields_container.get_data()[1]
+field_lc1 = stress_tensor.outputs.fields_container()[0]
+field_lc2 = stress_tensor.outputs.fields_container()[1]
 
 # Scale LC2 to -1.
 stress_tensor_lc2_sc = dpf.operators.math.scale(field=field_lc2, ponderation=-1.0)

examples/05-plotting/03-labels.py

@@ -58,24 +58,22 @@
 
 ###############################################################################
 # Get the stress tensor and ``connect`` time scoping.
-# Make sure that you define ``"Nodal"`` as the scoping location because
+# Make sure that you define ``dpf.locations.nodal`` as the scoping location because
 # labels are supported only for nodal results.
 #
 stress_tensor = model.results.stress()
-time_scope = dpf.Scoping()
-time_scope.ids = [20]  # [1, 2]
-stress_tensor.inputs.time_scoping.connect(time_scope)
-stress_tensor.inputs.requested_location.connect("Nodal")
+stress_tensor.inputs.time_scoping([20])
+stress_tensor.inputs.requested_location(dpf.locations.nodal)
 # field = stress_tensor.outputs.fields_container.get_data()[0]
 
-norm_op = dpf.Operator("norm_fc")
-norm_op.inputs.connect(stress_tensor.outputs)
+norm_op = dpf.operators.math.norm_fc()
+norm_op.inputs.connect(stress_tensor)
 field_norm_stress = norm_op.outputs.fields_container()[0]
 print(field_norm_stress)
 
 norm_op2 = dpf.Operator("norm_fc")
 disp = model.results.displacement()
-disp.inputs.time_scoping.connect(time_scope)
+disp.inputs.time_scoping.connect([20])
 norm_op2.inputs.connect(disp.outputs)
 field_norm_disp = norm_op2.outputs.fields_container()[0]
 print(field_norm_disp)

examples/08-averaging/01-average_across_bodies.py

@@ -281,7 +281,7 @@ def average_across_bodies(analysis):
 stress_op = ops.result.stress_eqv_as_mechanical()
 stress_op.inputs.time_scoping.connect([time_set])
 stress_op.inputs.data_sources.connect(model)
-stress_op.inputs.requested_location.connect("Nodal")
+stress_op.inputs.requested_location.connect(dpf.locations.nodal)
 stress_op.inputs.average_across_bodies.connect(False)
 
 print(stress_op.outputs.fields_container())

src/ansys/dpf/core/field.py

@@ -47,11 +47,12 @@ class Field(_FieldBase):
     nature : :class:`ansys.dpf.core.common.natures`, optional
         Nature of the field.
     location : str, optional
-        Location of the field.  Options are:
+        Location of the field.  Options are in :class:`locations <ansys.dpf.core.common.locations>`
 
-        - ``"Nodal"``
-        - ``"Elemental"``
-        - ``"ElementalNodal"``
+        - ``dpf.locations.nodal``
+        - ``dpf.locations.elemental``
+        - ``dpf.locations.elemental_nodal``
+        - ...
 
     field : Field, ansys.grpc.dpf.field_pb2.Field, ctypes.c_void_p, optional
         Field message generated from a gRPC stub, or returned by DPF's C clients.
@@ -248,8 +249,7 @@ def location(self):
         Returns
         -------
         str
-            Location string, which can be ``"Nodal"``, ``"Elemental"``,
-            ``"ElementalNodal"``... See :class:`ansys.dpf.core.common.locations`.
+            Location string, Options are in :class:`locations <ansys.dpf.core.common.locations>`.
 
         Examples
         --------
@@ -275,8 +275,7 @@ def location(self, value):
         Parameters
         -------
         location : str or locations
-            Location string, which can be ``"Nodal"``, ``"Elemental"``,
-            ``"ElementalNodal"``... See :class:`ansys.dpf.core.common.locations`.
+            Location string, Options are in :class:`locations <ansys.dpf.core.common.locations>`.
 
         Examples
         --------

src/ansys/dpf/core/field_definition.py

@@ -59,8 +59,9 @@ def location(self):
         Returns
         -------
         str
-            Location string, such as ``"Nodal"``, ``"Elemental"``,
-            or ``"TimeFreq_sets"``.
+            Location string, such as :class:`ansys.dpf.core.locations.nodal`,
+            :class:`ansys.dpf.core.locations.elemental` or
+            :class:`ansys.dpf.core.locations.time_freq`.
         """
         location = integral_types.MutableString(256)
         size = integral_types.MutableInt32(0)

src/ansys/dpf/core/fields_factory.py

@@ -66,7 +66,7 @@ def field_from_array(arr, server=None):
 def create_matrix_field(num_entities, num_lines, num_col, location=locations.nodal, server=None):
     """Create a matrix :class:`ansys.dpf.core.Field`.
 
-    This field contain entities that have a matrix format. This is a "reserve" mechanism,
+    This field contains entities that have a matrix format. This is a "reserve" mechanism,
     not a resize one. This means that you need to append data to grow the size of your field.
 
     Parameters
@@ -78,12 +78,8 @@ def create_matrix_field(num_entities, num_lines, num_col, location=locations.nod
     num_col : int
         Number of matrix columns.
     location : str, optional
-        Location of the field. The default is ``"Nodal"``. For example:
-
-        - :class:`ansys.dpf.core.natures.nodal` (``"Nodal"``)
-        - :class:`ansys.dpf.core.natures.elemental` (``"Elemental"``)
-        - :class:`ansys.dpf.core.natures.elemental_nodal` (``"ElementalNodal"``)
-        - ...
+        Location of the field. Options are in :class:`locations <ansys.dpf.core.common.locations>`.
+        The default is ``dpf.locations.nodal``.
 
     server : ansys.dpf.core.server, optional
         Server with the channel connected to the remote or local instance.
@@ -126,12 +122,8 @@ def create_3d_vector_field(num_entities, location=locations.nodal, server=None):
         Number of entities to reserve
 
     location : str, optional
-        Location of the field. The default is ``"Nodal"``. For example:
-
-        - ansys.dpf.core.natures.nodal (``"Nodal"``)
-        - ansys.dpf.core.natures.elemental (``"Elemental"``)
-        - ansys.dpf.core.natures.elemental_nodal (``"ElementalNodal"``)
-        - ...
+        Location of the field. Options are in :class:`locations <ansys.dpf.core.common.locations>`.
+        The default is ``dpf.locations.nodal``.
 
     server : ansys.dpf.core.server, optional
         Server with the channel connected to the remote or local instance.
@@ -165,12 +157,8 @@ def create_tensor_field(num_entities, location=locations.nodal, server=None):
     num_entities : int
         Number of entities to reserve.
     location : str, optional
-        Location of the field. The default is ``"Nodal"``. For example:
-
-        - :class:`ansys.dpf.core.natures.nodal` (``"Nodal"``)
-        - :class:`ansys.dpf.core.natures.elemental` (``"Elemental"``)
-        - :class:`ansys.dpf.core.natures.elemental_nodal` (``"ElementalNodal"``)
-        - ...
+        Location of the field. Options are in :class:`locations <ansys.dpf.core.common.locations>`.
+        The default is ``dpf.locations.nodal``.
 
     server : ansys.dpf.core.server, optional
         Server with the channel connected to the remote or local instance.
@@ -204,12 +192,8 @@ def create_scalar_field(num_entities, location=locations.nodal, server=None):
     num_entities : int
         Number of entities to reserve
     location : str, optional
-        Location of the field. The default is ``"Nodal"``. For example:
-
-        - ansys.dpf.core.natures.nodal (``"Nodal"``)
-        - ansys.dpf.core.natures.elemental (``"Elemental"``)
-        - ansys.dpf.core.natures.elemental_nodal (``"ElementalNodal"``)
-        - ...
+        Location of the field. Options are in :class:`locations <ansys.dpf.core.common.locations>`.
+        The default is ``dpf.locations.nodal``.
 
     server : ansys.dpf.core.server, optional
         Server with the channel connected to the remote or local instance.
@@ -245,12 +229,8 @@ def create_vector_field(num_entities, num_comp, location=locations.nodal, server
     num_comp : int
         Number of vector components.
     location : str, optional
-        Location of the field. The default is ``"Nodal"``. For example:
-
-        - ansys.dpf.core.natures.nodal (``"Nodal"``)
-        - ansys.dpf.core.natures.elemental (``"Elemental"``)
-        - ansys.dpf.core.natures.elemental_nodal (``"ElementalNodal"``)
-        - ...
+        Location of the field. Options are in :class:`locations <ansys.dpf.core.common.locations>`.
+        The default is ``dpf.locations.nodal``.
 
     server : ansys.dpf.core.server, optional
         Server with the channel connected to the remote or local instance.
@@ -286,22 +266,18 @@ def _create_field(server, nature, nentities, location=locations.nodal, ncomp_n=0
         Server with the channel connected to the remote or local instance.
         The default is ``None``, in which case an attempt is made to use the
         global server.
-    snature : str
+    nature : str
         Nature of the field entity data. For example:
 
         - :class:`ansys.dpf.core.natures.matrix`
         - :class:`ansys.dpf.core.natures.scalar`
 
-    num_entities : int
+    nentities : int
         Number of entities to reserve.
 
     location : str, optional
-        Location of the field. For example:
-
-        - :class:`ansys.dpf.core.natures.nodal` (``"Nodal"``)
-        - :class:`ansys.dpf.core.natures.elemental` (``"Elemental"``)
-        - :class:`ansys.dpf.core.natures.elemental_nodal` (``"ElementalNodal"``)
-        - ...
+        Location of the field. Options are in :class:`locations <ansys.dpf.core.common.locations>`.
+        The default is ``dpf.locations.nodal``.
 
     ncomp_n : int
         Number of lines.