check_dipole#

empymod.utils.check_dipole(inp, name, verb)[source]#

Check dipole parameters.

This check-function is called from one of the modelling routines in empymod.model. Consult these modelling routines for a detailed description of the input parameters.

Parameters:
inplist of floats or arrays

Pole coordinates (m): [pole-x, pole-y, pole-z].

namestr, {‘src’, ‘rec’}

Pole-type.

verb{0, 1, 2, 3, 4}

Level of verbosity.

Returns:
inplist

List of pole coordinates [x, y, z].

ninpint

Number of inp-elements