SourceField¶
-
class
emg3d.fields.
SourceField
[source]¶ Bases:
emg3d.fields.Field
Create a Source-Field instance with x-, y-, and z-views of the field.
A subclass of
Field
. Additional properties are the real-valued source vector (vector, vx, vy, vz), which sum is always one. For a SourceField frequency is a mandatory parameter, unlike for a Field (recommended also for Field though),Parameters: - fx_or_grid :
emg3d.meshes.TensorMesh
or ndarray Either a TensorMesh instance or an ndarray of shape grid.nEx or grid.vnEx. See explanations above. Only mandatory parameter; if the only one provided, it will initiate a zero-field of dtype.
- fy_or_field :
Field
or ndarray, optional Either a Field instance or an ndarray of shape grid.nEy or grid.vnEy. See explanations above.
- fz : ndarray, optional
An ndarray of shape grid.nEz or grid.vnEz. See explanations above.
- dtype : dtype, optional
Only used if
fy_or_field=None
andfz=None
; the initiated zero-field for the provided TensorMesh has data type dtype. Default: complex.- freq : float
Source frequency (Hz), used to compute the Laplace parameter s. Either positive or negative:
- freq > 0: Frequency domain, hence \(s = -\mathrm{i}\omega = -2\mathrm{i}\pi f\) (complex);
- freq < 0: Laplace domain, hence \(s = f\) (real).
In difference to Field, the frequency has to be provided for a SourceField.
Attributes Summary
vector
Entire vector, 1D [vx, vy, vz]. vx
View of the x-directed vector in the x-direction (nCx, nNy, nNz). vy
View of the vector in the y-direction (nNx, nCy, nNz). vz
View of the vector in the z-direction (nNx, nNy, nCz). Attributes Documentation
-
vector
¶ Entire vector, 1D [vx, vy, vz].
-
vx
¶ View of the x-directed vector in the x-direction (nCx, nNy, nNz).
-
vy
¶ View of the vector in the y-direction (nNx, nCy, nNz).
-
vz
¶ View of the vector in the z-direction (nNx, nNy, nCz).
- fx_or_grid :