Skip to content

Commit

Permalink
Specify the unit of the potential, in the documentation (#5035)
Browse files Browse the repository at this point in the history
  • Loading branch information
RemiLehe authored Jul 10, 2024
1 parent 45278d7 commit a0ce802
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Docs/source/usage/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ Domain Boundary Conditions
* ``open``: For the electrostatic Poisson solver based on a Integrated Green Function method.

* ``boundary.potential_lo_x/y/z`` and ``boundary.potential_hi_x/y/z`` (default `0`)
Gives the value of the electric potential at the boundaries, for ``pec`` boundaries. With electrostatic solvers
Gives the value of the electric potential, in Volts, at the boundaries, for ``pec`` boundaries. With electrostatic solvers
(i.e., with ``warpx.do_electrostatic = ...``), this is used in order to compute the potential
in the simulation volume at each timestep. When using other solvers (e.g. Maxwell solver),
setting these variables will trigger an electrostatic solve at ``t=0``, to compute the initial
Expand Down Expand Up @@ -603,7 +603,7 @@ Whether the embedded boundary is defined with an analytical function or an STL f
additionally define the electric potential at the embedded boundary with an analytical function:

* ``warpx.eb_potential(x,y,z,t)`` (`string`)
Gives the value of the electric potential at the surface of the embedded boundary,
Gives the value of the electric potential, in Volts, at the surface of the embedded boundary,
as a function of `x`, `y`, `z` and `t`. With electrostatic solvers (i.e., with
``warpx.do_electrostatic = ...``), this is used in order to compute the potential
in the simulation volume at each timestep. When using other solvers (e.g. Maxwell solver),
Expand Down

0 comments on commit a0ce802

Please sign in to comment.