differt.em.ShortDipole#
- class ShortDipole(frequency, num_wavelengths=0.5, *, length=None, moment=Array([0., 0., 1.], dtype=float32), current=1.0, charge=None, center=Array([0., 0., 0.], dtype=float32), look_at=None)[source]#
Bases:
DipoleShort dipole.
Like
Dipole, but accounts for the fact that the current is not constant across the dipole length, which leads to more realistic results.However, fields are only derived for far field.
Warning
Not implemented yed.
Attributes
The angular frequency \(\omega = 2 \pi f\).
The aperture \(A\) of an isotropic antenna.
The period \(T = 1/f\).
The reference power (W) radiated by this antenna.
The wavelength \(\lambda = c / f\).
The wavenumber \(k = \omega / c\).
Dipole length (in meter).
Dipole moment (in Coulomb-meter).
The frequency \(f\) at which the antenna is operating.
The center position of the antenna, from which the fields are radiated.
Methods
directive_gain([num_points])Compute an estimate of the antenna directive gain.
directivity([num_points])Compute an estimate of the antenna directivity for azimuthal and elevation angles.
fields(r[, t])Compute electric and magnetic fields in vacuum at given position and (optional) time.
plot_radiation_pattern([num_points, ...])Plot the radiation pattern (normalized power) of this antenna.
poynting_vector(r[, t])Compute the Poynting vector in vacuum at given position and (optional) time.
Detailed documentation
-
center:
Float[Array, '3']# The center position of the antenna, from which the fields are radiated.
Default value is the origin.
- directive_gain(num_points=int(1e2))[source]#
Compute an estimate of the antenna directive gain.
Note
Subclasses may provide a more accurate or exact implementation.
- Parameters:
num_points (
int) – The number of points used for the estimate.- Return type:
- Returns:
The antenna directive gain.
See also
- directivity(num_points=int(1e2))[source]#
Compute an estimate of the antenna directivity for azimuthal and elevation angles.
Note
Subclasses may provide a more accurate or exact implementation.
- Parameters:
num_points (
int) –The number of points to sample along the elevation axis.
Twice this number of points are sampled on the azimuthal axis.
- Return type:
tuple[Float[Array, '2*{num_points}'],Float[Array, '{num_points}'],Float[Array, '2*{num_points} {num_points}']]- Returns:
Azimuthal and elevation angles, as well as corresponding directivity values.
See also
- fields(r, t=None)[source]#
Compute electric and magnetic fields in vacuum at given position and (optional) time.
- Parameters:
r (
Float[ArrayLike, '*#batch 3']) – The array of positions.t (
Float[ArrayLike, '*#batch']|None) –The array of time instants.
If not provided, initial time instant is assumed.
- Return type:
tuple[Inexact[Array, '*batch 3'],Inexact[Array, '*batch 3']]- Returns:
The electric \(\vec{E}\) and magnetic \(\vec{B}\) fields.
Fields can be either real or complex-valued.
-
frequency:
Float[Array, '']# The frequency \(f\) at which the antenna is operating.
-
length:
Float[Array, '']# Dipole length (in meter).
-
moment:
Float[Array, '3']# Dipole moment (in Coulomb-meter).
- plot_radiation_pattern(num_points=int(1e2), distance=1.0, num_wavelengths=None, **kwargs)[source]#
Plot the radiation pattern (normalized power) of this antenna.
The power is computed on points on a sphere around the antenna.
- Parameters:
num_points (
int) –The number of points to sample along the elevation axis.
Twice this number of points are sampled on the azimuthal axis.
distance (
Float[ArrayLike, '']) – The distance from the antenna at which power samples are evaluated.num_wavelengths (
Float[ArrayLike, '']|None) – If provided, supersedesdistanceby setting the distance relatively to thewavelength.kwargs (
Any) – Keyword arguments passed todraw_surface.
- Return type:
- Returns:
The resulting plot output.
- poynting_vector(r, t=None)[source]#
Compute the Poynting vector in vacuum at given position and (optional) time.
- Parameters:
r (
Float[ArrayLike, '*#batch 3']) – The array of positions.t (
Float[ArrayLike, '*#batch']|None) –The array of time instants.
If not provided, initial time instant is assumed.
- Return type:
- Returns:
The Poynting vector \(\vec{S}\).
It can be either real or complex-valued.
-
center: