AeroAcousticOutput

class AeroAcousticOutput

Bases: Flow360BaseModel

AeroAcousticOutput class for aeroacoustic output settings.

Example

>>> fl.AeroAcousticOutput(
...     observers=[
...         fl.Observer(position=[1.0, 0.0, 1.75] * fl.u.m, group_name="1"),
...         fl.Observer(position=[0.2, 0.3, 1.725] * fl.u.m, group_name="1"),
...     ],
... )

If using permeable surfaces:

>>> fl.AeroAcousticOutput(
...     observers=[
...         fl.Observer(position=[1.0, 0.0, 1.75] * fl.u.m, group_name="1"),
...         fl.Observer(position=[0.2, 0.3, 1.725] * fl.u.m, group_name="1"),
...     ],
...     patch_type="permeable",
...     permeable_surfaces=[volume_mesh["inner/interface*"]]
... )

Attributes

name: str, optional

Name of the AeroAcousticOutput.

Default:

'Aeroacoustic output'

patch_type: Literal['solid', 'permeable']

Type of aeroacoustic simulation to perform. solid uses solid walls to compute the aeroacoustic solution. permeable uses surfaces embedded in the volumetric domain as aeroacoustic solver input. Cannot be changed when a case is forked unless force_clean_start is true.

Default:

'solid'

permeable_surfaces: EntityList[Surface, GhostCircularPlane, GhostSphere, WindTunnelGhostSurface], optional

List of permeable surfaces. Leave empty if patch_type is solid. Cannot be changed when a case is forked unless force_clean_start is true.

Default:

None

observers: list[Observer]

A List of Observer objects specifying each observer’s position and group name. Cannot be changed when a case is forked unless force_clean_start is true.

write_per_surface_output: bool

Enable writing of aeroacoustic results on a per-surface basis, in addition to results for all wall surfaces combined.

Default:

False

observer_time_step_size: Time.PositiveFloat64, optional

Time step size for aeroacoustic output. A valid value is larger than or equal to the time step size of the CFD simulation. Defaults to time step size of CFD. Cannot be changed when a case is forked unless force_clean_start is true.

Default:

None

aeroacoustic_solver_start_time: Time.NonNegativeFloat64

Time to start the aeroacoustic solver. Signals emitted after this start time at the source surfaces are included in the output. Cannot be changed when a case is forked unless force_clean_start is true.

Default:

0 * fl.u.s

force_clean_start: bool

Restart the aeroacoustic solver when a case is forked, instead of continuing the parent case’s acoustic signal. The flow solution still continues from the parent. Required to change patch_type, permeable_surfaces, observers, observer_time_step_size or aeroacoustic_solver_start_time in a forked case. Only applies to forked cases.

Default:

False

Methods

classmethod validate_observer_has_same_unit(input_value)

All observer location should have the same length unit. This is because UI has single toggle for all coordinates.

check_consistent_patch_type_and_permeable_surfaces()

Check if permeable_surfaces is None when patch_type is solid.

classmethod ensure_surface_existence(value)

Ensure all boundaries will be present after mesher