Skip to content

Commit

Permalink
DOCS: add advanced fields calc API (#5155)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmalinve authored Sep 11, 2024
1 parent 618cfec commit 634988a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 5 deletions.
27 changes: 23 additions & 4 deletions doc/source/API/Post.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Postprocessing
==============
Post-processing
===============
This section lists modules for creating and editing
plots in AEDT. They are accessible through the ``post`` property.
plots in AEDT and shows how to interact with AEDT fields calculator.
They are accessible through the ``post`` property.

.. note::
Some capabilities of the ``advanced_post_processing`` module require Python 3 and
Expand All @@ -13,6 +14,8 @@ plots in AEDT. They are accessible through the ``post`` property.
Some functionalities are available only when AEDT is running
in graphical mode.

Advanced post-processing
~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: ansys.aedt.core.modules

Expand Down Expand Up @@ -73,9 +76,11 @@ PyAEDT has classes for manipulating any report property.
report_templates.Emission
report_templates.Spectral


Icepak monitors
~~~~~~~~~~~~~~~
The ``monitor_icepak`` module includes the classes listed below to add, modify, and manage monitors during simulations.
Retrieve monitor values for post-processing and analysis to gain insights into key simulation metrics.
Methods and properties are accessible through the ``monitor`` property of the ``Icepak`` class.

.. currentmodule:: ansys.aedt.core.modules.monitor_icepak

Expand All @@ -87,3 +92,17 @@ Icepak monitors
FaceMonitor
PointMonitor
Monitor

Advanced fields calculator
~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``fields_calculator`` module includes the ``FieldsCalculator`` class.
It provides methods to interact with AEDT Fields Calculator by adding, loading and deleting custom expressions.

.. currentmodule:: ansys.aedt.core.modules.fields_calculator

.. autosummary::
:toctree: _autosummary
:nosignatures:


FieldsCalculator
2 changes: 1 addition & 1 deletion src/ansys/aedt/core/modules/fields_calculator.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class FieldsCalculator:
Parameters
----------
app:
app :
Inherited parent object.
Examples
Expand Down

0 comments on commit 634988a

Please sign in to comment.