pyAEDTM2D_Lum

.github/workflows/docs.yml

@@ -47,6 +47,12 @@ jobs:
     with:
       doc-build: true
 
+  maxwell2d-lumerical:
+    uses: ./.github/workflows/maxwell2d-lumerical.yml
+    secrets: inherit
+    with:
+      doc-build: true
+
   compile-docs:
     runs-on: ubuntu-latest
     # TODO: enable when issues in PyMechanical are resolved
@@ -106,6 +112,12 @@ jobs:
           name: mapdl-dpf-docs
           path: doc/
 
+      - name: Download artifacts for maxwell2d-lumerical
+        uses: actions/download-artifact@v7
+        with:
+          name: maxwell2d-lumerical-docs
+          path: doc/
+
       - name: Build the documentation
         run: |
           cd doc

.github/workflows/maxwell2d-lumerical.yml

@@ -0,0 +1,101 @@
+name: Maxwell2D Lumerical Workflow
+
+on:
+  workflow_dispatch:
+    inputs:
+      doc-build:
+        required: false
+        default: false
+        type: boolean
+        description: 'Whether to build the documentation'
+  workflow_call:
+    inputs:
+      doc-build:
+        required: false
+        default: false
+        type: boolean
+        description: 'Whether to build the documentation'
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - 'maxwell2d-lumerical/**'
+
+env:
+  ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER )}}
+  ANSYS_RELEASE_FOR_DOCS: 25.2
+  ANSYSEM_ROOT252: 'C:\Program Files\ANSYS Inc\v252\AnsysEM'
+  MAIN_PYTHON_VERSION: '3.12'
+  ON_CI: true
+
+jobs:
+
+  is-only-docs-required:
+    uses: ./.github/workflows/check-docs-required.yml
+    with:
+      doc-build: ${{ inputs.doc-build || false }}
+
+  maxwell2d-lumerical:
+    name: Maxwell2D Lumerical
+    runs-on: [self-hosted, Windows, pyansys-workflows]
+    needs: is-only-docs-required
+    strategy:
+      fail-fast: false
+      matrix:
+        ansys-release: ${{ needs.is-only-docs-required.outputs.only-docs == 'true' && fromJSON('[25.2]') || fromJSON('[25.2]') }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493 # v4.2.2
+        with:
+          sparse-checkout: |
+            maxwell2d-lumerical
+            doc
+
+      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
+        uses: actions/setup-python@2e3e4b15a884dc73a63f962bff250a855150a234 # v5.6.0
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+      - name: Install dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          python -m venv .venv
+          source .venv/Scripts/activate
+          pip install -r maxwell2d-lumerical/requirements_${{ matrix.ansys-release }}.txt
+
+      - name: Run the workflow script
+        env:
+          AEDT_VERSION: ${{ matrix.ansys-release }}
+        shell: bash
+        run: |
+          source .venv/Scripts/activate
+          python maxwell2d-lumerical/wf_ml_01_ion_trap_modelling.py
+
+      - name: (DOCS) Build the documentation (only on ${{ env.ANSYS_RELEASE_FOR_DOCS}})
+        if: needs.is-only-docs-required.outputs.only-docs == 'true' && matrix.ansys-release == env.ANSYS_RELEASE_FOR_DOCS
+        env:
+          BUILD_DOCS_SCRIPT: 'maxwell2d-lumerical/wf_ml_01_ion_trap_modelling.py'
+        shell: bash
+        run: |
+          source .venv/Scripts/activate
+          cd doc
+          pip install -r requirements.txt
+          ./make.bat html
+
+      - name: (DOCS) Adapt the documentation paths
+        if: needs.is-only-docs-required.outputs.only-docs == 'true' && matrix.ansys-release == env.ANSYS_RELEASE_FOR_DOCS
+        shell: bash
+        run: |
+          find doc/_build -type f -exec sed -i 's|C:\\Users\\ansys\\actions-runner\\_work\\pyansys-workflows\\pyansys-workflows\\doc\\source\\examples\\maxwell2d-lumerical\\images\\|./images/|g' {} +
+
+      - name: (DOCS) Upload docs artifacts
+        if: needs.is-only-docs-required.outputs.only-docs == 'true' && matrix.ansys-release == env.ANSYS_RELEASE_FOR_DOCS
+        uses: actions/upload-artifact@v4
+        with:
+          name: maxwell2d-lumerical-docs
+          path: |
+            doc/_build/
+            doc/source/examples/maxwell2d-lumerical/
+          overwrite: true

.github/workflows/speos-optislang.yml

@@ -98,7 +98,7 @@ jobs:
           BUILD_DOCS_SCRIPT: 'speos-optislang/wf_so_01_light_guide_robustness_study.py'
         shell: bash
         run: |
-          .venv/Scripts/activate
+          source .venv/Scripts/activate
           cd doc
           pip install -r requirements.txt
           ./make.bat html

README.md

@@ -26,26 +26,37 @@ for every part of the simulation process. The available workflows are:
     - For geometry: Ansys SpaceClaim / Ansys Discovery / Ansys Geometry Service
     - For meshing: Ansys Fluent Meshing
     - For simulation: Ansys Fluent Solver
-- [Geometry, mechanical and post-processing](https://github.com/ansys/pyansys-workflows/tree/main/geometry-mechanical-dpf): this workflow demonstrates how to
+
+- [Geometry, mechanical and postprocessing](https://github.com/ansys/pyansys-workflows/tree/main/geometry-mechanical-dpf): this workflow demonstrates how to
   create a printed circuit board (PCB) geometry, mesh, run steady state and transient thermal analysis,
-  and post-process using DPF. The geometry generated is a simple PCB with multiple chips.
+  and postprocess using DPF. The geometry generated is a simple PCB with multiple chips.
   The exported CAD file (PMDB format) is then imported inside Ansys Mechanical
   to run a steady-state thermal analysis followed by transient analysis.
   All temperature results in different chips are displayed using DPF. The involved Ansys products are:
     - For geometry: Ansys SpaceClaim / Ansys Discovery / Ansys Geometry Service
     - For simulation: Ansys Mechanical
-    - For post-procesing: Ansys Data Processing Framework
-- [Fluent and mechanical analysis](https://github.com/ansys/pyansys-workflows/tree/main/fluent-mechanical): this workflow demonstrates how to perform a Conjugate Heat Transfer (CHT) analysis for an exhaust manifold to simulate heat transfer between solid and fluid domains, calculate heat transfer coefficients (HTCs) and temperature distribution, and export results for thermo-mechanical analysis. The thermo-mechanical assessment is then performed to evaluate the exhaust manifold's performance under thermal cycling, aiding in design optimization for durability
-  The involved Ansys products are:
+    - For postprocesing: Ansys Data Processing Framework
+
+- [Fluent and mechanical analysis](https://github.com/ansys/pyansys-workflows/tree/main/fluent-mechanical): this workflow demonstrates how to perform a Conjugate Heat Transfer (CHT) analysis for an exhaust manifold to simulate heat transfer between solid and fluid domains, calculate heat transfer coefficients (HTCs) and temperature distribution, and export results for thermo-mechanical analysis. The workflow then performs thermo-mechanical assessment to evaluate the exhaust manifold's performance under thermal cycling, aiding in design optimization for durability
+  These Ansys products are used:
     - For fluids analysis: Ansys Fluent
     - For thermal analysis: Ansys Mechanical
-- [Speos and optiSLang robustness analysis](https://github.com/ansys/pyansys-workflows/tree/main/speos-optislang): this workflow performs a robustness
-   study to evaluate how variations in LED source power and position influence lightguide performance using PySpeos and PyOptiSLang. The analysis quantifies performance
-   through key metrics such as RMS contrast, average luminance, and the number of failed regulations.
-  The involved Ansys products are:
+
+- [Speos and optiSLang robustness analysis](https://github.com/ansys/pyansys-workflows/tree/main/speos-optislang): this workflow performs a robustness study to evaluate how variations in LED source power and position influence lightguide performance. The analysis quantifies performance through key metrics such as RMS contrast, average luminance, and the number of failed regulations.
+
+These Ansys products are used:
     - For optical analysis: Ansys Speos
     - For robustness analysis: Ansys optiSLang
 
+- [Maxwell2D and Lumerical ion trap modelling](https://github.com/ansys/pyansys-workflows/tree/main/maxwell2d-lumerical): this workflow
+  is fully automated and models a chip-based ion trap that incorporates optical antennas with surface electrodes.
+  Ansys Maxwell computes the electrostatic response of a three-rail surface electrode design, while Ansys Lumerical retrieves the data
+  from Maxwell to optimize the grating coupler design that operates as an optical antenna for tightly focused laser beams.
+  For additional information, see this article:
+    https://optics.ansys.com/hc/en-us/articles/20715978394131-Integrated-Ion-Traps-using-Surface-Electrodes-and-Grating-Couplers
+  In this article is also shown how multiple grating couplers can provide a platform for more complex field distributions and optical force calculation
+  over various nano-objects.
+
 ## How to run the workflows
 
 All workflows are structured in the same way, with a Python script for each part of the simulation process.

doc/source/conf.py

@@ -145,6 +145,7 @@ def examples_gallery_dirs_and_filename_pattern():
             "../../geometry-mesh",
             "../../geometry-mesh-fluent",
             "../../speos-optislang",
+            "../../maxwell2d-lumerical",
         ]
         gallery_dirs = [
             "examples/fluent-mechanical",
@@ -153,6 +154,7 @@ def examples_gallery_dirs_and_filename_pattern():
             "examples/geometry-mesh",
             "examples/geometry-mesh-fluent",
             "examples/speos-optislang",
+            "examples/maxwell2d-lumerical",
         ]
 
     return examples_dirs, gallery_dirs, filename_pattern

doc/source/examples.rst

@@ -12,9 +12,11 @@ Workflow examples
    examples/geometry-mesh-fluent/index
    examples/mapdl-dpf/index
    examples/speos-optislang/index
+   examples/maxwell2d-lumerical/index
    .. TODO: enable when issues in PyMechanical are resolved
       examples/geometry-mechanical-dpf/index
 
+
 .. include:: examples/fluent-mechanical/index.rst
     :start-line: 1
     :end-before: .. toctree
@@ -36,6 +38,10 @@ Workflow examples
     :start-line: 1
     :end-before: .. toctree
 
+.. include:: examples/maxwell2d-lumerical/index.rst
+    :start-line: 1
+    :end-before: .. toctree
+
 .. include:: examples/speos-optislang/index.rst
     :start-line: 1
-    :end-before: .. toctree
+    :end-before: .. toctree

maxwell2d-lumerical/.gitignore

@@ -0,0 +1 @@
+outputs