planeWavePulse

planeWavePulse

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimVE licenses.

A plane wave modulated by a Gaussian transversely and a half-sine longitudinally.

planeWavePulse Parameters

omega (required float)

Angular frequency of the wave \(\omega\).

k (required float vector)

The wave vector \({\bf k}\).

amplitude (required float)

Amplitude of the wave.

phase (optional float, default = 0)

The phase, added to \(({\bf k} \cdot {\bf x} - \omega t)\).

origin (required float vector)

The initial location of the peak of the pulse. This is usually located a distance widths[0] outside the simulation domain, so that the value of the function is initially zero everywhere in the simulation. The pulse then propagates into the simulation domain.

widths (required float vector)

The widths of the pulse:

widths[0]

Full half-width of the pulse in the longitudinal direction (i.e. along \(\mathbf{k}\)). The half-sine function reaches zero at this distance away from the peak.

widths[1]

The width of the Gaussian beam in the direction perpendicular to \(\mathbf{k}\) in the plane of \(\mathbf{k}\) and \(\mathbf{\hat{x}}\); if \(\mathbf{k}\) is parallel to \(\mathbf{\hat{x}}\), this is the width in the \(y\) direction. The width is the full-width at the \(1/\sqrt{e}\) points (of the function value, not function squared).

widths[2]

The width of the Gaussian beam in the direction perpendicular to both \(\mathbf{k}\) and \(\mathbf{\hat{x}}\); if \(\mathbf{k}\) is parallel to \(\mathbf{\hat{x}}\), this is the width in the \(z\) direction. The width is the full-width at the \(1/\sqrt{e}\) points (of the function value, not function squared).

vg (required float)

Group velocity, by which the origin of the envelope is moved.

skewness (optional float, default = 0)

Skewness in the pulse.

keepon (optional integer, default = 0 (false))

If true, the pulse does not fall after getting to its peak value.

Example halfSinePulse Block

<STFunc function>
  kind = planeWavePulse     # Function used for E_z
  omega = OMEGA             # Angular frequency parameter for function
  k = [KAY  0  0]           # k-vector parameter for function
  amplitude = EWAVE
  phase = 1.57
  widths = [ 5.e-6  1.e-5  1.e-5]   # widths of pulses, along k, transverse
  origin = [-5.e-6  0.e-5  0.e-5]   # Origin parameter for function
  vg = LIGHTSPEED           # Group velocity parameter for function
</STFunc>