.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "examples\00-basic\10-math_operations.py" .. LINE NUMBERS ARE GIVEN BELOW. .. only:: html .. note:: :class: sphx-glr-download-link-note :ref:`Go to the end ` to download the full example code .. rst-class:: sphx-glr-example-title .. _sphx_glr_examples_00-basic_10-math_operations.py: .. _ref_math_operators_example: Mathematical Operations ~~~~~~~~~~~~~~~~~~~~~~~ DPF provides operators for implementing mathematical operations, ranging from addition and multiplication to FFT and QR solving. For a complete list, see :ref:`ref_dpf_operators_reference`, under the math section. .. GENERATED FROM PYTHON SOURCE LINES 14-18 .. code-block:: Python # Import the necessary modules import ansys.dpf.core as dpf .. GENERATED FROM PYTHON SOURCE LINES 19-21 Addition ~~~~~~~~ .. GENERATED FROM PYTHON SOURCE LINES 21-34 .. code-block:: Python # Initialize Fields num_entities = 2 field1 = dpf.Field(nentities=2) field2 = dpf.Field(nentities=2) # By default, Fields contain 3d vectors. # So with three entities we need nine values. field1.data = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0] field2.data = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0] field1.scoping.ids = range(num_entities) field2.scoping.ids = range(num_entities) .. GENERATED FROM PYTHON SOURCE LINES 35-36 Once the fields are ready, we can instantiate an operator. .. GENERATED FROM PYTHON SOURCE LINES 36-38 .. code-block:: Python add_op = dpf.operators.math.add(field1, field2) .. GENERATED FROM PYTHON SOURCE LINES 39-40 Finally, we use eval() to compute and retrieve the result. .. GENERATED FROM PYTHON SOURCE LINES 40-45 .. code-block:: Python field3 = add_op.eval() # = [[2. 4. 6.] [8. 10. 12.]] print(field3.data) .. rst-class:: sphx-glr-script-out .. code-block:: none [[ 2. 4. 6.] [ 8. 10. 12.]] .. GENERATED FROM PYTHON SOURCE LINES 46-48 Dot product ~~~~~~~~~~~ .. GENERATED FROM PYTHON SOURCE LINES 48-56 .. code-block:: Python dot_op = dpf.operators.math.generalized_inner_product(field1, field2) # (1. * 1.) + (2. * 2.) + (3. * 3.) = 14. # (4. * 4.) + (5. * 5.) + (6. * 6.) = 77. field3 = dot_op.eval() print(field3.data) .. rst-class:: sphx-glr-script-out .. code-block:: none [14. 77.] .. GENERATED FROM PYTHON SOURCE LINES 57-59 Power ~~~~~ .. GENERATED FROM PYTHON SOURCE LINES 59-70 .. code-block:: Python field = dpf.Field(nentities=1) field1.data = [1.0, 2.0, 3.0] field1.scoping.ids = [1] pow_op = dpf.operators.math.pow(field1, 3.0) # [1. 8. 27.] field3 = pow_op.eval() print(field3.data) .. rst-class:: sphx-glr-script-out .. code-block:: none [[ 1. 8. 27.]] .. GENERATED FROM PYTHON SOURCE LINES 71-73 L2 norm ~~~~~~~ .. GENERATED FROM PYTHON SOURCE LINES 73-81 .. code-block:: Python field1.data = [16.0, -8.0, 2.0] norm_op = dpf.operators.math.norm(field1) # [ 18. ] field3 = norm_op.eval() print(field3.data) .. rst-class:: sphx-glr-script-out .. code-block:: none [18.] .. GENERATED FROM PYTHON SOURCE LINES 82-88 Accumulate ~~~~~~~~~~ First we define fields. By default, fields represent 3D vectors so one elementary data is a 3D vector. The optional ponderation field is a field which takes one value per entity, so we need to change its dimensionality (1D). .. GENERATED FROM PYTHON SOURCE LINES 88-96 .. code-block:: Python num_entities = 3 input_field = dpf.Field(nentities=num_entities) ponderation_field = dpf.Field(num_entities) ponderation_field.dimensionality = dpf.Dimensionality([1]) input_field.scoping.ids = range(num_entities) ponderation_field.scoping.ids = range(num_entities) .. GENERATED FROM PYTHON SOURCE LINES 97-99 Fill fields with data. Add nine values because there are three entities. .. GENERATED FROM PYTHON SOURCE LINES 99-100 .. code-block:: Python input_field.data = [-2.0, 2.0, 4.0, -5.0, 0.5, 1.0, 7.0, 3.0, -3.0] .. GENERATED FROM PYTHON SOURCE LINES 101-102 Three weights, one per entity. .. GENERATED FROM PYTHON SOURCE LINES 102-104 .. code-block:: Python ponderation_field.data = [0.5, 2.0, 0.5] .. GENERATED FROM PYTHON SOURCE LINES 105-106 Retrieve the result. .. GENERATED FROM PYTHON SOURCE LINES 106-114 .. code-block:: Python acc = dpf.operators.math.accumulate(fieldA=input_field, ponderation=ponderation_field) output_field = acc.outputs.field() # (-2.0 * 0.5) + (-5.0 * 2.0) + (7.0 * 0.5) = -7.5 # (2.0 * 0.5) + (0.5 * 2.0) + (3.0 * 0.5) = 3.5 # (4.0 * 0.5) + (1.0 * 2.0) + (-3.0 * 0.5) = 2.5 print(output_field.data) .. rst-class:: sphx-glr-script-out .. code-block:: none [[-7.5 3.5 2.5]] .. GENERATED FROM PYTHON SOURCE LINES 115-117 With scoping ~~~~~~~~~~~~ .. GENERATED FROM PYTHON SOURCE LINES 117-120 .. code-block:: Python field1.data = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0] field2.data = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0] .. GENERATED FROM PYTHON SOURCE LINES 121-129 Next, we need to provide information about the scoping. DPF needs to know the IDs of the data we just provided, so that it can apply an operator on a subset of the original data. By providing these integers we only select the data with an ID in common. Here we are selecting the third elementary data of the first field, and the first elementary data of the second field, Other elementary data is not taken into account when using an operator that needs two operands. .. GENERATED FROM PYTHON SOURCE LINES 129-141 .. code-block:: Python field1.scoping.ids = [1, 2, 3] field2.scoping.ids = [3, 4, 5] add_op = dpf.operators.math.add(field1, field2) field3 = add_op.eval() # Only the third entity was changed # because it is the only operator where two operands were provided. print(field3.data) # [[8. 10. 12.]] print(field3.get_entity_data_by_id(3)) .. rst-class:: sphx-glr-script-out .. code-block:: none [[ 1. 2. 3.] [ 4. 5. 6.] [ 8. 10. 12.] [ 4. 5. 6.] [ 7. 8. 9.]] [[ 8. 10. 12.]] .. GENERATED FROM PYTHON SOURCE LINES 142-143 Dot product .. GENERATED FROM PYTHON SOURCE LINES 143-151 .. code-block:: Python dot_op = dpf.operators.math.generalized_inner_product(field1, field2) # We obtain zeros for IDs where there could not be two operands. # (7. * 1.) + (8. * 2.) + (9. * 3.) = 50. # [0. 0. 50. 0. 0.] field3 = dot_op.eval() print(field3.data) .. rst-class:: sphx-glr-script-out .. code-block:: none [ 0. 0. 50. 0. 0.] .. rst-class:: sphx-glr-timing **Total running time of the script:** (0 minutes 0.031 seconds) .. _sphx_glr_download_examples_00-basic_10-math_operations.py: .. only:: html .. container:: sphx-glr-footer sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: 10-math_operations.ipynb <10-math_operations.ipynb>` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: 10-math_operations.py <10-math_operations.py>` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_