kwave.recorder module#

class Recorder[source]#

Bases: object

Recorder()

I#

time-varying acoustic intensity

I_avg#

time-averaged acoustic intensity

__init__()[source]#
static get_allowed_flags(is_elastic_code)[source]#

Get the list of allowed flags for a given simulation type

Parameters:

is_elastic_code – Whether the simulation is axisymmetric

Returns:

List of allowed flags for a given simulation type

is_set(attrs)[source]#

Check if the attributes are set

Parameters:

attrs (List[str]) – Attributes to check

Returns:

List of individual boolean results

Return type:

List[bool]

p#

time-varying acoustic pressure

p_final#

final pressure field at all grid points

p_max#

maximum pressure over simulation

p_max_all#

maximum pressure over simulation at all grid points

p_min#

minimum pressure over simulation

p_min_all#

minimum pressure over simulation at all grid points

p_rms#

root-mean-squared pressure over simulation

set_flags_from_list(flags_list, is_elastic_code)[source]#

Set Recorder flags that are present in the string list to True

Parameters:

  • flags_list (List[str]) – String list of flags that should be set to True

  • is_elastic_code (bool) – Is the simulation elastic

Returns:

None

Return type:

None

set_index_variables(kgrid, pml_size, is_pml_inside, is_axisymmetric)[source]#

Assign the index variables

Parameters:

  • kgrid (kWaveGrid) – kWaveGrid instance

  • pml_size (Vector) – Size of the PML

  • is_pml_inside (bool) – Whether the PML is inside the grid defined by the user

  • is_axisymmetric (bool) – Whether the simulation is axisymmetric

Returns:

None

Return type:

None

u#

time-varying particle velocity

u_final#

final particle velocity field at all grid points

u_max#

maximum particle velocity over simulation

u_max_all#

maximum particle velocity over simulation at all grid points

u_min#

minimum particle velocity over simulation

u_min_all#

minimum particle velocity over simulation at all grid points

u_non_staggered#

time-varying particle velocity on non-staggered grid

u_rms#

root-mean-squared particle velocity over simulation

u_split_field#

compressional and shear components of time-varying particle velocity