Add math tutorials to the main tutorials branch #1910
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luisaFelixSalles
changed the base branch from
master
to
doc/new-tutorials-section
|
@luisaFelixSalles can we scroll down in the out section here? |
|
It seems there mismatches between code and output How come? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## doc/new-tutorials-section #1910 +/- ##
=============================================================
- Coverage 88.50% 88.44% -0.07%
=============================================================
Files 89 89
Lines 10251 10251
=============================================================
- Hits 9073 9066 -7
- Misses 1178 1185 +7 |
PProfizi
reviewed
Nov 19, 2024
Yes we can, I think is just not in the screenshot |
luisaFelixSalles
force-pushed
the
tutorials/math/firsts-math-tutorials
branch
from
ce9b1fc to
cd37263
Compare
luisaFelixSalles
force-pushed
the
tutorials/math/firsts-math-tutorials
branch
from
4a1bf3b to
0b7935b
Compare
luisaFelixSalles
force-pushed
the
doc/new-tutorials-section
branch
from
576cd9f to
627c2de
Compare
luisaFelixSalles
force-pushed
the
tutorials/math/firsts-math-tutorials
branch
from
4606b6a to
939a805
Compare
jorgepiloto
reviewed
Dec 23, 2024
jorgepiloto
reviewed
Dec 23, 2024
jorgepiloto
reviewed
Dec 23, 2024
| - The entities ids and location. Thus, the |Field| scoping | ||
|
|
||
| - If not specified, the location is *'nodal'* by default. | ||
| - Each entity (here, the nodes) must have a |Scoping| id. The ids allows DPF to apply an operator on the |
There was a problem hiding this comment.
Suggested change
| - Each entity (here, the nodes) must have a |Scoping| id. The ids allows DPF to apply an operator on the | |
| - Each node must have a |Scoping| id. The ids allows DPF to apply an operator on the |
jorgepiloto
reviewed
Dec 23, 2024
jorgepiloto
reviewed
Dec 23, 2024
Co-authored-by: Jorge Martínez <[email protected]>
PProfizi
reviewed
May 13, 2025
|
|
||
| .. tab-item:: Fields | ||
|
|
||
| Create the Fields by defining: |
There was a problem hiding this comment.
Suggested change
| Create the Fields by defining: | |
| Create the fields based on: |
PProfizi
reviewed
May 13, 2025
Comment on lines
+58
to
+63
| - The entities ids and location. Thus, the |Field| scoping | ||
|
|
||
| - If not specified, the location is *'nodal'* by default. | ||
| - Each entity (here, the nodes) must have a |Scoping| id. The ids allows DPF to apply an operator on the | ||
| corresponding entities. For more detailed explanation about the influence of the |Scoping| on the operations, | ||
| see the :ref:`ref_basic_maths_scoping_handling` section on this tutorial. |
There was a problem hiding this comment.
Suggested change
| - The entities ids and location. Thus, the |Field| scoping | |
| - If not specified, the location is *'nodal'* by default. | |
| - Each entity (here, the nodes) must have a |Scoping| id. The ids allows DPF to apply an operator on the | |
| corresponding entities. For more detailed explanation about the influence of the |Scoping| on the operations, | |
| see the :ref:`ref_basic_maths_scoping_handling` section on this tutorial. | |
| - A list of IDs and a location, which together define the scoping of the field: | |
| The location defines the type of entity the IDs refer to. It defaults to *nodal*, in which case the scoping is | |
| understood as a list of node IDs, and the field is a nodal field. | |
| For a more detailed explanation about the influence of the |Scoping| on the operations, | |
| see the :ref:`ref_basic_maths_scoping_handling` section of this tutorial. |
PProfizi
reviewed
May 13, 2025
| .. |norm| replace:: :class:`norm<ansys.dpf.core.operators.math.norm.norm>` | ||
| .. |norm_fc| replace:: :class:`norm_fc<ansys.dpf.core.operators.math.norm_fc.norm_fc>` | ||
|
|
||
| This tutorial explains how to do some basic mathematical operations with PyDPF-Core. |
There was a problem hiding this comment.
Suggested change
| This tutorial explains how to do some basic mathematical operations with PyDPF-Core. | |
| This tutorial explains how to perform some basic mathematical operations with PyDPF-Core. |
PProfizi
reviewed
May 13, 2025
| DPF uses |Field| and |FieldsContainer| objects to handle data. The |Field| is a homogeneous array and | ||
| a |FieldsContainer| is a labeled collection of |Field|. | ||
|
|
||
| Here, we use |Field| and |FieldsContainer| created from scratch to facilitate the understanding on how the |
There was a problem hiding this comment.
Suggested change
| Here, we use |Field| and |FieldsContainer| created from scratch to facilitate the understanding on how the | |
| Here, we use |Field| and |FieldsContainer| created from scratch to facilitate understanding of how the |
PProfizi
reviewed
May 13, 2025
| a |FieldsContainer| is a labeled collection of |Field|. | ||
|
|
||
| Here, we use |Field| and |FieldsContainer| created from scratch to facilitate the understanding on how the | ||
| mathematical operators works. For more information on creating a |Field| from scratch check |
There was a problem hiding this comment.
Suggested change
| mathematical operators works. For more information on creating a |Field| from scratch check | |
| mathematical operators work. For more information on creating a |Field| from scratch check |
PProfizi
reviewed
May 13, 2025
|
|
||
| Create the Fields by defining: | ||
|
|
||
| - The number of entities |
There was a problem hiding this comment.
Suggested change
| - The number of entities | |
| - A number of entities |
PProfizi
reviewed
May 13, 2025
| # Import the math operators module | ||
| from ansys.dpf.core.operators import math as maths | ||
|
|
||
| Create the Fields by intanciating the |Field| object. |
There was a problem hiding this comment.
Suggested change
| Create the Fields by intanciating the |Field| object. | |
| Create the fields with the |Field| class constructor. |
PProfizi
reviewed
May 13, 2025
|
|
||
| .. jupyter-execute:: | ||
|
|
||
| # Instantiate the Fields |
There was a problem hiding this comment.
Suggested change
| # Instantiate the Fields | |
| # Create the fields |
PProfizi
reviewed
May 13, 2025
| num_entities = 2 | ||
| field1 = field2 = field3 = field4 = dpf.Field(nentities=num_entities) | ||
|
|
||
| # Define the scoping ids |
There was a problem hiding this comment.
Suggested change
| # Define the scoping ids | |
| # Set the scoping IDs |
PProfizi
reviewed
May 13, 2025
| # Define the scoping ids | ||
| field1.scoping.ids = field2.scoping.ids = field3.scoping.ids = field4.scoping.ids = range(num_entities) | ||
|
|
||
| # Set the data to each Field |
There was a problem hiding this comment.
Suggested change
| # Set the data to each Field | |
| # Set the data for each field |
PProfizi
reviewed
May 13, 2025
| field3.data = [6.0, 5.0, 4.0, 3.0, 2.0, 1.0] | ||
| field4.data = [4.0, 1.0, 8.0, 5.0, 7.0, 9.0] | ||
|
|
||
| # Print the Fields |
There was a problem hiding this comment.
Suggested change
| # Print the Fields | |
| # Print the fields |
PProfizi
reviewed
May 13, 2025
|
|
||
| .. tab-item:: FieldsContainers | ||
|
|
||
| Create the FieldsContainers using the |fields_container_factory|. Here, we use the |over_time_freq_fields_container| |
There was a problem hiding this comment.
Suggested change
| Create the FieldsContainers using the |fields_container_factory|. Here, we use the |over_time_freq_fields_container| | |
| Create the field containers using the |fields_container_factory|. Here, we use the |over_time_freq_fields_container| |
PProfizi
reviewed
May 13, 2025
Comment on lines
+102
to
+106
| # Create the FieldsContainers | ||
| fc1 = dpf.fields_container_factory.over_time_freq_fields_container(fields=[field1, field2]) | ||
| fc2 = dpf.fields_container_factory.over_time_freq_fields_container(fields=[field3, field4]) | ||
|
|
||
| # Print the FieldsContainers |
There was a problem hiding this comment.
Suggested change
| # Create the FieldsContainers | |
| fc1 = dpf.fields_container_factory.over_time_freq_fields_container(fields=[field1, field2]) | |
| fc2 = dpf.fields_container_factory.over_time_freq_fields_container(fields=[field3, field4]) | |
| # Print the FieldsContainers | |
| # Create the field containers | |
| fc1 = dpf.fields_container_factory.over_time_freq_fields_container(fields=[field1, field2]) | |
| fc2 = dpf.fields_container_factory.over_time_freq_fields_container(fields=[field3, field4]) | |
| # Print the field containers |
PProfizi
reviewed
May 13, 2025
| print("FieldsContainer2","\n", fc2, "\n") | ||
|
|
||
|
|
||
| To make the mathematics operations, we use the operators available in the |math operators| module. |
There was a problem hiding this comment.
Suggested change
| To make the mathematics operations, we use the operators available in the |math operators| module. | |
| To perform mathematical operations, we use operators available in the |math operators| module. |
PProfizi
reviewed
May 13, 2025
Comment on lines
+112
to
+113
| Their usage is similar, for each operation you must instantiate the operator and use ``.eval()`` method to compute | ||
| and retrieve the results. |
There was a problem hiding this comment.
Suggested change
| Their usage is similar, for each operation you must instantiate the operator and use ``.eval()`` method to compute | |
| and retrieve the results. | |
| First create an instance of the operator of interest, then use the ``.eval()`` method to compute | |
| and retrieve the first output available. |
PProfizi
reviewed
May 13, 2025
| Their usage is similar, for each operation you must instantiate the operator and use ``.eval()`` method to compute | ||
| and retrieve the results. | ||
|
|
||
| Mathematical operations with Fields |
There was a problem hiding this comment.
Suggested change
| Mathematical operations with Fields | |
| Mathematical operations with fields |
PProfizi
reviewed
May 13, 2025
|
|
||
| Here, we use: | ||
|
|
||
| - The |add| operator for component wise addition |
There was a problem hiding this comment.
Suggested change
| - The |add| operator for component wise addition | |
| - The |add| operator for component-wise addition |
PProfizi
reviewed
May 13, 2025
|
|
||
| **'add' operator** | ||
|
|
||
| This operator computes the sum between the data vectors for the corresponding entity id. |
There was a problem hiding this comment.
Suggested change
| This operator computes the sum between the data vectors for the corresponding entity id. | |
| This operator computes the sum of two fields. |
PProfizi
reviewed
May 13, 2025
Comment on lines
+133
to
+139
| # Add the Fields | ||
| add_field = maths.add(fieldA=field1, fieldB=field2).eval() | ||
| # id 0: [1.+7. 2.+3. 3.+5.] | ||
| # id 1: [4.+8. 5.+1. 6.+2.] | ||
|
|
||
| # Print the results | ||
| print("Addition fields",add_field , "\n") |
There was a problem hiding this comment.
Suggested change
| # Add the Fields | |
| add_field = maths.add(fieldA=field1, fieldB=field2).eval() | |
| # id 0: [1.+7. 2.+3. 3.+5.] | |
| # id 1: [4.+8. 5.+1. 6.+2.] | |
| # Print the results | |
| print("Addition fields",add_field , "\n") | |
| # Add the fields | |
| add_field = maths.add(fieldA=field1, fieldB=field2).eval() | |
| # id 0: [1.+7. 2.+3. 3.+5.] | |
| # id 1: [4.+8. 5.+1. 6.+2.] | |
| # Print the results | |
| print("Addition field ", add_field , "\n") |
PProfizi
reviewed
May 13, 2025
|
|
||
| **'accumulate' operator** | ||
|
|
||
| This operator sums all the elementary data of a field to produce one elementary data for each vector component. |
There was a problem hiding this comment.
Suggested change
| This operator sums all the elementary data of a field to produce one elementary data for each vector component. | |
| This operator computes the total sum of elementary data of a field, for each component of the field. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds the tutorials of the math section
List of tutorials:
Preview on how it renders:
Mathematics section main page
Basic maths