k-Wave Binary Driver

class kwave_bin_driver.KWaveBinaryDriver(start_sampling_time=0, binary_path='kspaceFirstOrder-OMP', reorder_data=False)

Represents k-Wave solver.

class VerbosityLevel

An enumeration.

__init__(start_sampling_time=0, binary_path='kspaceFirstOrder-OMP', reorder_data=False)

Constructor of k-Wave solver object.

Parameters
  • start_sampling_time – First time-step which will be sampled and store as the output.

  • binary_path – Path to k-Wave solver binary.

  • reorder_data – Whether input file was created with data reordering enabled.

run(input_file: kwave_input_file.KWaveInputFile, output_file: kwave_output_file.KWaveOutputFile, time_steps=None)

Execute k-Wave solver binary with specified input file to generate specified output file.

Parameters
  • input_file – Previously generated input file (see KWaveInputFile).

  • output_file – Previously created output file (see KWaveOutputFile)

  • time_steps – Ignores number of time-steps specified in the input file when set.

store_pressure_at_sensor(sampling_types: List[kwave_output_file.SensorSamplingType])
Store pressure at points specified by the sensor mask/indexes in the input file using specified reduction

methods.

Parameters

sampling_types – List of elements from SensorSamplingType enum.

store_pressure_everywhere(sampling_types: List[kwave_output_file.DomainSamplingType])

Store pressure in the whole simulation domain using specified reduction methods.

Parameters

sampling_types – List of reduction methods from DomainSamplingType enum.

store_velocity_at_sensor(sampling_types: List[kwave_output_file.SensorSamplingType], non_staggered_raw=False)
Store velocity at points specified by the sensor mask/indexes in the input file using specified reduction

methods.

Parameters
  • sampling_types – List of elements from SensorSamplingType enum.

  • non_staggered_raw – RAW non-staggered velocity is sampled when set to True.

store_velocity_everywhere(sampling_types: List[kwave_output_file.DomainSamplingType])

Store velocity in the whole simulation domain using specified reduction methods.

Parameters

sampling_types – List of reduction methods from DomainSamplingType enum.