CSPropDumpBox

class CSXCAD.CSProperties.CSPropDumpBox

Bases: CSPropProbeBox

Dump property to create field dumps.

Depending on the EM modeling tool there exist different dump types, dump modes and file types with different meanings.

openEMS dump types:

  • 0 : for E-field time-domain dump (default)

  • 1 : for H-field time-domain dump

  • 2 : for electric current time-domain dump

  • 3 : for total current density (rot(H)) time-domain dump

  • 10 : for E-field frequency-domain dump

  • 11 : for H-field frequency-domain dump

  • 12 : for electric current frequency-domain dump

  • 13 : for total current density (rot(H)) frequency-domain dump

  • 20 : local SAR frequency-domain dump

  • 21 : 1g averaging SAR frequency-domain dump

  • 22 : 10g averaging SAR frequency-domain dump

  • 29 : raw data needed for SAR calculations (electric field FD, cell volume, conductivity and density)

openEMS dump modes:

  • 0 : no-interpolation

  • 1 : node-interpolation (default, see warning below)

  • 2 : cell-interpolation (see warning below)

openEMS file types:

  • 0 : vtk-file (default)

  • 1 : hdf5-file (easier to read by python, using h5py)

Parameters:

  • dump_type – dump type (see above)

  • dump_mode – dump mode (see above)

  • file_type – file type (see above)

  • frequency – specify a frequency vector (required for dump types >=10)

  • sub_sampling – field domain sub-sampling, e.g. ‘2,2,4’

  • opt_resolution – field domain dump resolution, e.g. ‘10’ or ‘10,20,5’

Notes

openEMS FDTD Interpolation abnormalities:

  • no-interpolation:

    fields are located in the mesh by the Yee-scheme, the mesh only specifies E- or H-Yee-nodes –> use node- or cell-interpolation or be aware of the offset

  • E-field dump & node-interpolation:

    normal electric fields on boundaries will have false amplitude due to forward/backward interpolation in case of (strong) changes in material permittivity or on metal surfaces –> use no- or cell-interpolation

  • H-field dump & cell-interpolation:

    normal magnetic fields on boundaries will have false amplitude due to forward/backward interpolation in case of (strong) changes in material permeability –> use no- or node-interpolation

GetDumpMode()
GetDumpType()
GetFileType()
GetOptResolution()
GetSubSampling()
SetDumpMode(val)
SetDumpType(val)
SetFileType(val)
SetOptResolution(val)
SetSubSampling(val)