Update docs

awslabs · Dec 30, 2024 · 81a8fec · 81a8fec
1 parent d21f1e7
commit 81a8fec
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/docs/src/config/boundaries.md b/docs/src/config/boundaries.md
@@ -60,6 +60,10 @@
     [
         ...
     ],
+    "FloquetWaveVector":
+    [
+        ...
+    ],
     "Postprocessing":
     {
         "SurfaceFlux":
@@ -127,7 +131,7 @@ each terminal boundary.
 `"Periodic"` :  Array of objects for configuring periodic boundary conditions for surfaces
 with meshes that are identical after translation and/or rotation.
 
-`"FloquetWaveVector"` :  Object for configuring Floquet periodic boundary conditions for
+`"FloquetWaveVector"` :  Array for specifying Floquet wave vector for
 meshes generated with built-in periodicity.
 
 `"Postprocessing"` :  Top-level object for configuring boundary postprocessing.

diff --git a/docs/src/config/solver.md b/docs/src/config/solver.md
@@ -432,7 +432,9 @@ iterative solver choices, and the default choice depends on the iterative solver
   - `"Default"`
 
 `"DivFreeTol" [1.0e-12]` :  Relative tolerance for divergence-free cleaning used in the
-eigenmode simulation type.
+eigenmode simulation type. Ignored if non-zero Floquet wave vector is specified in
+[`config["Boundaries"]["Periodic"]["FloquetWaveVector"]`](boundaries.md##boundaries%5B%%22Periodic%22%5D%22FloquetWaveVector%22%5D)
+or [`config["Boundaries"]["FloquetWaveVector"]`](boundaries.md##boundaries%5B%%22FloquetWaveVector%22%5D).
 
 `"DivFreeMaxIts" [1000]` :  Maximum number of iterations for divergence-free cleaning use in
 the eigenmode simulation type.