simnibs.simulation.tms_coil

simnibs.simulation.tms_coil(mesh, cond, cond_list, fn_coil, fields, matsimnibs_list, didt_list, output_names, geo_names=None, solver_options=None, n_workers=1)

Simulates TMS fields using a coil + matsimnibs + dIdt definition.

Parameters:
  • mesh (simnibs.msh.mesh_io.Msh) – Mesh structure

  • cond (simnibs.msh.mesh_io.ElementData) – Conductivity field

  • fields (str or list of str) – Fields to be calculated for each position

  • fn_coil (string) – Relative path of coil file

  • matsimnibs_list (list) – List of “matsimnibs” matrices, one per position

  • didt_list (list) – List of dIdt values, one per position or a list of dIdt values, one per stimulator

  • output_names (list of str) – List of output mesh file names, one per position

  • geo_names (list of str) – List of output mesh file names, one per position

  • solver_options (str) – Options for the solver

  • n_workers (int) – Number of workers to use

  • fn_stl (string) – Name of stl-file for coil visualization

Return type:

Writes output meshes to the files specified in output_names