Add possibility for e-current

empymod/model.py

@@ -302,6 +302,9 @@ def bipole(src, rec, depth, res, freqtime, signal=None, aniso=None,
         If True, the output is squeezed. If False, the output will always be of
         ``ndim=3``, (nfreqtime, nrec, nsrc).
 
+    ecurrent : bool, default: False
+        TODO description ecurrent
+
 
     Returns
     -------
@@ -310,6 +313,7 @@ def bipole(src, rec, depth, res, freqtime, signal=None, aniso=None,
 
         - If rec is electric, returns E [V/m].
         - If rec is magnetic, returns H [A/m].
+        - TODO description ecurrent; check for msrc=True
 
         EMArray is a subclassed ndarray with `.pha` and `.amp` attributes
         (only relevant for frequency-domain data).
@@ -379,10 +383,11 @@ def bipole(src, rec, depth, res, freqtime, signal=None, aniso=None,
     """
     # Get kwargs with defaults.
     out = get_kwargs(
-        ['verb', 'ht', 'htarg', 'ft', 'ftarg', 'xdirect', 'loop', 'squeeze'],
-        [2, 'dlf', {}, 'dlf', {}, False, None, True], kwargs,
+        ['verb', 'ht', 'htarg', 'ft', 'ftarg', 'xdirect', 'loop', 'squeeze',
+         'ecurrent'],
+        [2, 'dlf', {}, 'dlf', {}, False, None, True, False], kwargs,
     )
-    verb, ht, htarg, ft, ftarg, xdirect, loop, squeeze = out
+    verb, ht, htarg, ft, ftarg, xdirect, loop, squeeze, ecurrent = out
 
     # === 1.  LET'S START ============
     t0 = printstartfinish(verb)
@@ -528,6 +533,11 @@ def bipole(src, rec, depth, res, freqtime, signal=None, aniso=None,
                 src_rec_w *= np.tile(rec_w, isrc)
             sEM *= src_rec_w
 
+            # Multiply with eta of the rec-layer if ecurrent.
+            if ecurrent:
+                print(sEM.shape, etaH.shape, etaH[:, lrec, None].shape)
+                sEM *= etaH[:, lrec, None]
+
             # Add this src-rec signal
             if nrec == nrecz:
                 if nsrc == nsrcz:  # Case 1: Looped over each src and each rec

empymod/utils.py

@@ -1797,7 +1797,8 @@ def get_kwargs(names, defaults, kwargs):
     known_keys = set([
             'depth', 'ht', 'htarg', 'ft', 'ftarg', 'xdirect', 'loop', 'signal',
             'ab', 'freqtime', 'freq', 'wavenumber', 'solution', 'cf', 'gain',
-            'msrc', 'srcpts', 'mrec', 'recpts', 'strength', 'squeeze'
+            'msrc', 'srcpts', 'mrec', 'recpts', 'strength', 'squeeze',
+            'ecurrent',
     ])
 
     # Loop over wanted parameters.