From c157c0b8cd4ba73fd07197fc70b169c1b49e642f Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Mon, 17 Mar 2025 11:44:02 +0000 Subject: [PATCH] Updated wording in discrete plane wave entry. --- docs/source/input_hash_cmds.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/input_hash_cmds.rst b/docs/source/input_hash_cmds.rst index 72d41438..9fb3614d 100644 --- a/docs/source/input_hash_cmds.rst +++ b/docs/source/input_hash_cmds.rst @@ -913,7 +913,7 @@ Allows you to introduce a discrete plane wave source [TAN2010]_. Plane wave sour * ``f7`` is psi which defines the polarisation of the incident plane wave. * ``f8`` is phi which defines the azimuthal propagation angle (degrees) of the incident plane wave. * ``f9`` is theta which defines the polar propagation angle (degrees) of the incident plane wave. -* ``f10 f11`` are optional parameters. ``f10`` is a time delay in starting the excitation of the transmission line. ``f11`` is a time to remove the excitation of the transmission line. If the time window is longer than the excitation of the transmission line removal time then the excitation of the transmission line will stop after the excitation of the transmission line removal time. If the excitation of the transmission line removal time is longer than the time window then the excitation of the transmission line will be active for the entire time window. If ``f10 f11`` are omitted the excitation of the transmission line will start at the beginning of time window and stop at the end of the time window. +* ``f10 f11`` are optional parameters. ``f10`` is a time delay in starting the excitation of the discrete plane wave. ``f11`` is a time to remove the excitation of the discrete plane wave. If the time window is longer than the excitation of the discrete plane wave removal time then the excitation of the discrete plane wave will stop after the excitation of the discrete plane wave removal time. If the excitation of the discrete plane wave removal time is longer than the time window then the excitation of the discrete plane wave will be active for the entire time window. If ``f10 f11`` are omitted the excitation of the discrete plane wave will start at the beginning of time window and stop at the end of the time window. * ``str1`` is the identifier of the waveform that should be used with the source. For example, to specify a discrete plane wave in a TFSF box (0.010, 0.010, 0.010 to 0.040, 0.040, 0.040) with a polarisation angle of 90 degrees, azimuthal propagation angle of 63.4 degrees, polar propagation angle of 36.7 degrees, and using the waveform defined by the identifier ``mypulse`` use: ``#discrete_plane_wave: 0.010 0.010 0.010 0.040 0.040 0.040 90.0 63.4 36.7 mypulse``.