wave_equation_options#

class ansys.fluent.core.solver.tui_231.main_menu.define.models.acoustics.wave_equation_options(path, service)#

Bases: TUIMenu

Enters the menu to define the acoustics wave equation model options.

Classes:

basic_shapes(path, service)

Enters the menu to define the geometry of the source mask and sponge layer using the basic shapes, represented by the cell registers of the type "Region".

remote_receivers_options(path, service)

Enters the menu to define remote receivers for the Kirchhoff integral model.

Methods:

remote_receivers(*args, **kwargs)

Enables/disables the Kirchhoff integral model.

source_mask_udf(*args, **kwargs)

Specifies the name of a user-defined function, which defines geometry of the source mask.

sponge_layer_base_level(*args, **kwargs)

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)

Specifies the factor of the artificial viscosity coefficient.

sponge_layer_udf(*args, **kwargs)

Specifies the name of a user-defined function, which defines geometry of the sponge layer.

time_filter_source(*args, **kwargs)

Enables/disables a time filter for the sound source.
class basic_shapes(path, service)#

Bases: TUIMenu

Enters the menu to define the geometry of the source mask and sponge layer using the basic shapes, represented by the cell registers of the type “Region”.

Methods:

add_source_mask_shape(*args, **kwargs)

Adds a basic shape to the definition of the source mask geometry.

add_sponge_layer_shape(*args, **kwargs)

Adds a basic shape to the definition of the sponge layer geometry.

list_region_registers(*args, **kwargs)

List all available cell registers of the type "Region".

list_source_mask_shapes(*args, **kwargs)

List basic shapes, which are currently used in the definition of the source mask geometry.

list_sponge_layer_shapes(*args, **kwargs)

List basic shapes, which are currently used in the definition of the sponge layer geometry.

remove_source_mask_shape(*args, **kwargs)

Remove a basic shape from the definition of the source mask geometry.

remove_sponge_layer_shape(*args, **kwargs)

Remove a basic shape from the definition of the sponge layer geometry.
add_source_mask_shape(*args, **kwargs)#

Adds a basic shape to the definition of the source mask geometry.

add_sponge_layer_shape(*args, **kwargs)#

Adds a basic shape to the definition of the sponge layer geometry.

list_region_registers(*args, **kwargs)#

List all available cell registers of the type “Region”.

list_source_mask_shapes(*args, **kwargs)#

List basic shapes, which are currently used in the definition of the source mask geometry.

list_sponge_layer_shapes(*args, **kwargs)#

List basic shapes, which are currently used in the definition of the sponge layer geometry.

remove_source_mask_shape(*args, **kwargs)#

Remove a basic shape from the definition of the source mask geometry.

remove_sponge_layer_shape(*args, **kwargs)#

Remove a basic shape from the definition of the sponge layer geometry.

remote_receivers(*args, **kwargs)#

Enables/disables the Kirchhoff integral model.

class remote_receivers_options(path, service)#

Bases: TUIMenu

Enters the menu to define remote receivers for the Kirchhoff integral model.

Methods:

integration_surface(*args, **kwargs)

Selects the integration surface for the Kirchhoff model.

write_signals(*args, **kwargs)

Writes the computed receiver signals to the ASCII files.
integration_surface(*args, **kwargs)#

Selects the integration surface for the Kirchhoff model.

write_signals(*args, **kwargs)#

Writes the computed receiver signals to the ASCII files.

source_mask_udf(*args, **kwargs)#

Specifies the name of a user-defined function, which defines geometry of the source mask.

sponge_layer_base_level(*args, **kwargs)#

Specify artificial viscosity base level applied everywhere.

sponge_layer_factor(*args, **kwargs)#

Specifies the factor of the artificial viscosity coefficient.

sponge_layer_udf(*args, **kwargs)#

Specifies the name of a user-defined function, which defines geometry of the sponge layer.

time_filter_source(*args, **kwargs)#

Enables/disables a time filter for the sound source.