doc: Add tutorial to understand cyclic models#3160
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3160 +/- ##
===========================================
+ Coverage 44.86% 82.93% +38.07%
===========================================
Files 93 93
Lines 11600 11602 +2
===========================================
+ Hits 5204 9622 +4418
+ Misses 6396 1980 -4416 |
PProfizi
added
tutorials
|
@rafacanton sorry about that it looks like there is currently an issue with the PyAnsys action for deploying the doc of a PR. You can ignore that. |
| When a model possesses cyclic symmetry, only one sector (the base sector) is solved. | ||
| DPF can read these results in different ways depending on the ``read_cyclic`` option | ||
| passed to a result operator. This tutorial demonstrates the four modes available | ||
| (``0``, ``1``, ``2``, ``3``) and shows how to perform phase sweeping on the expanded |
There was a problem hiding this comment.
@rafacanton did you choose to showcase a phase sweep because this is what people usually do?
I fear that by focusing on phase sweeps we may loose the generic topic of dealing with cyclic symmetries.
Performing phase sweeps could be in another tutorial.
Or are we performing one simply because the only cyclic example we have is this one and it requires a phase sweep to show the expanded displacement field?
There was a problem hiding this comment.
I would have preferred to showcase how to extract expanded results and use them along with expanded/non-expanded meshes.
There was a problem hiding this comment.
What I mean is that this is very harmonic-frequency-analysis-oriented while the goal of the tutorial is to show how to deal with cyclic models in general.
| # provides the number of sectors, node counts on the base sector, and the | ||
| # mapping between low and high boundary nodes. | ||
| # | ||
| # The |TimeFreqSupport| describes how solution sets map to harmonic indices and |
There was a problem hiding this comment.
This too is specific to frequency domain analyses, but we are presenting the CyclicSupport.
|
|
||
| ############################################################################### | ||
| # Get the CyclicSupport from the ResultInfo. The CyclicSupport allows to understand | ||
| # the cyclic information of the model. We can see that we have only 1 stage with 8 |
There was a problem hiding this comment.
Do we have any example with several stages?
If the goal of the tutorial is to present the CyclicSupport, which happens to store information about stages, maybe we need a better example.
| print(f"read_cyclic=3, first field entities: {len(disp_rc3[0])}") | ||
|
|
||
| ############################################################################### | ||
| # Phase sweeping on expanded results |
There was a problem hiding this comment.
Ok so it's not that this is not great and I don't want it here, it's more that I think it deserves its own tutorial so that people can find this information better.
|
The documentation for this pull request will be available at https://dpf.docs.pyansys.com/pull/3160. Please allow some time for the documentation to be deployed. |
2 participants
No description provided.