JOSS article

• Version of the JOSS article, https://doi.org/10.21105/joss.01463 .
• New function utils.grid2grid to move from one grid to another. Both functions (utils.get_receiver and utils.grid2grid) can be used for fields and model parameters (with or without extrapolation). They are very similar, the former taking coordinates (x, y, z) as new points, the latter one another TensorMesh instance.
• New jitted function njitted.volume_average for interpolation using the volume-average technique.
• New parameter conjugate in solver.solver to permit both Fourier transform conventions.
• Added exit_status and exit_message to info_dict.
• Add section Related ecosystem to documentation.

H-field

• New routines:

  • utils.get_h_field: Small routine to calculate the magnetic field from the electric field using Faraday's law.
  • utils.get_receiver: Small wrapper to interpolate a field at receiver positions. Added 3D spline interpolation; is the new default.

• Re-implemented the possibility to define isotropic magnetic permeabilities in utils.Model. Magnetic permeability is not tri-axially included in the solver currently; however, it would not be too difficult to include if there is a need.

• CPU-graph added on top of RAM-graph.

• Expand utils.Field to work with pickle/shelve.

• Jit np.linalg.norm (njitted.l2norm).

• Use scooby (soft dependency) for versioning, rename Version to Report (backwards incompatible).

• Bug fixes:

  • Small bugfix introduced in ebd2c9d: sc_cycle and lr_cycle was not updated any longer at the end of a cycle (only affected sslsolver=True.
  • Small bugfix in utils.get_hx.

CPU & RAM

Further speed and memory improvements:

• Add CPU & RAM-page to documentation.

• Change loop-order from x-z-y to z-x-y in Gauss-Seidel smoothing with line relaxation in y-direction. Hence reversed lexicographical order. This results in a significant speed-up, as x is the fastest changing axis.

• Move total residual calculation from solver.residual into njitted.amat_x.

• Simplifications in utils:

  • Simplify utils.get_source_field.
  • Simplify utils.Model.
  • Removed unused timing-stuff from early development.

Memory

Memory and speed improvements:

• Only calculate residual and l2-norm when absolutely necessary.
• Inplace calculations for np.conjugate in solver.solver and np.subtract in solver.residual.

RegularGridInterpolator

• Replace scipy.interpolate.RegularGridInterpolator with a custom tailored version of it (solver.RegularGridProlongator); results in twice as fast prolongation.
• Simplify the fine-grid calculation in prolongation without using gridE*; memory friendlier.
• Submission to JOSS.
• Add Multi-what?-page to documentation.
• Some major refactoring, particularly in solver.
• Removed discretize as hard dependency.
• Rename rdir and ldir (and related p*dir; *cycle) to the more descriptive sc_dir and lr_dir.

Accepts any grid size

• First open-source version.
• Include RTD, Travis, Coveralls, Codacy, and Zenodo. No benchmarks yet.
• Accepts now any grid size (warns if a bad grid size for MG is provided).
• Coarsens now to the lowest level of each dimension, not only to the coarsest level of the smallest dimension.
• Combined restrict_rx, restrict_ry, and restrict_rz to restrict.
• Improve speed by passing pre-allocated arrays to jitted functions.
• Store res_y, res_z and corresponding eta_y, eta_z only if res_y, res_z were provided in initial call to utils.model.
• Change zeta to v_mu_r.
• Include rudimentary TensorMesh-class in utils; removes hard dependency on discretize.
• Bugfix: Take a provided efield into account; don't return if provided.