kwave.kWaveSimulation_helper.expand_grid_matrices module

calculate_expand_size(kgrid, is_axisymmetric, pml_size)[source]
expand_cuboid_corner_list(is_cuboid_list, kgrid, pml_size)[source]

add the PML size to cuboid corner indices if using a cuboid sensor mask

Parameters:

  • is_cuboid_list

  • kgrid

  • pml_size (Vector)

Returns:

expand_directivity_angle(kgrid, sensor, expand_size, is_use_sensor, is_compute_directivity)[source]

enlarge the directivity angle if given (2D only)

Parameters:

  • kgrid

  • sensor

  • expand_size

  • is_use_sensor

  • is_compute_directivity

Returns:

expand_grid_matrices(kgrid, medium, source, sensor, opt, values, flags)[source]
Parameters:
expand_kgrid(kgrid, is_axisymmetric, pml_size)[source]
expand_medium(medium, expand_size)[source]
Parameters:

medium (kWaveMedium)

expand_pressure_sources(source, expand_size, is_source_p0, is_source_p, index_data_type, p_source_pos_index)[source]
expand_sensor(sensor, expand_size, is_use_sensor, is_blank_sensor)[source]

enlarge the sensor mask (for Cartesian sensor masks and cuboid corners, this has already been converted to a binary mask for display in inputChecking)

Parameters:

  • sensor

  • expand_size

  • is_use_sensor

  • is_blank_sensor

Returns:

expand_source(source, is_source_sensor_same, flags, expand_size, index_data_type, p_source_pos_index, u_source_pos_index, s_source_pos_index)[source]
expand_stress_sources(source, expand_size, flags, index_data_type, s_source_pos_index)[source]
expand_velocity_sources(source, expand_size, is_source_sensor_same, index_data_type, u_source_pos_index, is_source_ux, is_source_uy, is_source_uz, is_transducer_source)[source]

enlarge the velocity source mask if given

Parameters:

  • source

  • expand_size

  • is_source_sensor_same

  • index_data_type

  • u_source_pos_index

  • is_source_ux

  • is_source_uy

  • is_source_uz

  • is_transducer_source

Returns:

print_grid_size(kgrid)[source]

update command line status

Parameters:

kgrid

Returns: