aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar RevathiJambunathan <revanathan@gmail.com> 2020-01-14 11:40:13 -0800
committerGravatar RevathiJambunathan <revanathan@gmail.com> 2020-01-14 11:40:13 -0800
commit5f2c8f2c6940f46ee630248cf2737ba8036f169d (patch)
tree621e0864bc530f631378ce4b1b7faf26c91b42ee /Docs/source/running_cpp
parenteb6089d8ad31c0fa34acc9592f4fc0f9fe7099fb (diff)
downloadWarpX-5f2c8f2c6940f46ee630248cf2737ba8036f169d.tar.gz
WarpX-5f2c8f2c6940f46ee630248cf2737ba8036f169d.tar.zst
WarpX-5f2c8f2c6940f46ee630248cf2737ba8036f169d.zip
changing docs to add time in EB parser for particles
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 4fd60b8af..8bc3756e6 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -731,9 +731,9 @@ Laser initialization
To parse a mathematical function for the external B-field, use the option
``parse_B_ext_particle_function``. This option requires additional parameters
in the input file, namely,
- ``warpx.Bx_external_particle_function(x,y,z)``,
- ``warpx.By_external_particle_function(x,y,z)``,
- ``warpx.Bz_external_particle_function(x,y,z)`` to apply the external B-field
+ ``warpx.Bx_external_particle_function(x,y,z,t)``,
+ ``warpx.By_external_particle_function(x,y,z,t)``,
+ ``warpx.Bz_external_particle_function(x,y,z,t)`` to apply the external B-field
on the particles. Constants required in the mathematical expression can be set
using ``my_constants``. For a two-dimensional simulation, it is assumed that
the first and second dimensions are `x` and `z`, respectively, and the
@@ -752,9 +752,9 @@ Laser initialization
To parse a mathematical function for the external E-field, use the option
``parse_E_ext_particle_function``. This option requires additional
parameters in the input file, namely,
- ``warpx.Ex_external_particle_function(x,y,z)``,
- ``warpx.Ey_external_particle_function(x,y,z)``,
- ``warpx.Ez_external_particle_function(x,y,z)`` to apply the external E-field
+ ``warpx.Ex_external_particle_function(x,y,z,t)``,
+ ``warpx.Ey_external_particle_function(x,y,z,t)``,
+ ``warpx.Ez_external_particle_function(x,y,z,t)`` to apply the external E-field
on the particles. Constants required in the mathematical expression can be set
using ``my_constants``. For a two-dimensional simulation, similar to the B-field,
it is assumed that the first and second dimensions are `x` and `z`, respectively,