Skip to content

Commit

Permalink
Add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuelopez-ansys committed Jan 29, 2025
1 parent a4ea97a commit bed43e4
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions doc/source/User_guide/pyaedt_extensions_doc/hfss/shielding.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Shielding Effectiveness
=======================

The **Shielding Effectiveness** extension computes the shielding effectiveness of an enclosure.
It calculates the attenuation of an electromagnetic field inside the enclosure due to the presence of a shield.

The extension provides a graphical user interface (GUI) for configuration,
or it can be used in batch mode via command line arguments.

The following image shows the extension GUI:

.. image:: ../../../_static/extensions/shielding_ui.png
:width: 800
:alt: Shielding Effectiveness GUI


Features
--------

- Configure input parameters including source sphere radius, polarization, start and stop frequency and dipole type.
- Automatic HFSS setup.
- Switch between light and dark themes in the GUI.


Using the extension
-------------------

1. Open the **Automation** tab in the HFSS interface.
2. Locate and click the **Choke designer** icon under the Extension Manager.
3. In the GUI, users can interact with the following elements:
- **Source sphere radius**: Source sphere radius in meters. It must fit inside the shielding.
- **Polarization**: X, Y, Z polarization component.
- **Frequency**: Start and stop frequency and the number of steps to analyze.
- **Electric dipole**: Dipole type selection. Electric or magnetic dipole are available.
- **Cores**: Number of cores for the simulation.
4. Click on **Launch** to start the automated workflow.


Command line
------------

The extension can also be used directly via the command line for batch processing.


Use the following syntax to run the extension:

.. toctree::
:maxdepth: 2

../commandline
Binary file added doc/source/_static/extensions/shielding_ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bed43e4

Please sign in to comment.