From a2d725ebb068a7b0928238240fecb0c35962f7c0 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Wed, 17 Aug 2016 09:59:47 +0100 Subject: [PATCH] Edited text on scaling of maximum amplitude of waveform. --- docs/source/input.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/input.rst b/docs/source/input.rst index 349b98a6..bdfb9ee0 100644 --- a/docs/source/input.rst +++ b/docs/source/input.rst @@ -640,7 +640,7 @@ Allows you to specify waveforms to use with sources in the model. The syntax of * ``ricker`` which is a Ricker (or Mexican hat) waveform, i.e. the negative, normalised second derivative of a Gaussian waveform. * ``sine`` which is a single cycle of a sine waveform. * ``contsine`` which is a continuous sine waveform. In order to avoid introducing noise into the calculation the amplitude of the waveform is modulated for the first cycle of the sine wave (ramp excitation). -* ``f1`` is the amplitude of the waveform (for a ``#hertzian_dipole`` the units will be Amps, for a ``#voltage_source`` or ``#transmission_line`` the units will be Volts). +* ``f1`` is the scaling of the maximum amplitude of the waveform (for a ``#hertzian_dipole`` the units will be Amps, for a ``#voltage_source`` or ``#transmission_line`` the units will be Volts). * ``f2`` is the frequency of the waveform (Hertz). * ``str2`` is an identifier for the waveform used to assign it to a source.