flow360.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*"]]
... )

---

name: str | None = 'Aeroacoustic output'

Name of the AeroAcousticOutput.

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

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.

permeable_surfaces: EntityList[Surface, GhostSurface, GhostCircularPlane, GhostSphere, WindTunnelGhostSurface] | None = None

List of permeable surfaces. Left empty if patch_type is solid

observers: List[Observer] [Required]

A List of Observer objects specifying each observer’s position and group name.

write_per_surface_output: bool = False

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

observer_time_step_size: Annotated[_Constrained, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] | None = None

Time step size for aeroacoustic output. A valid value is smaller than or equal to the time step size of the CFD simulation. Defaults to time step size of CFD.

aeroacoustic_solver_start_time: Annotated[_Constrained, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] = unyt_quantity(0, 's')

Time to start the aeroacoustic solver. Signals emitted after this start time at the source surfaces are included in the output.

Constraints:

• func = <function _dimensioned_type_serializer at 0x76d26c7ff370>

• return_type = PydanticUndefined

• when_used = always

force_clean_start: bool = False

Force a clean start when an aeroacoustic case is forked.

output_type: Literal['AeroAcousticOutput'] = 'AeroAcousticOutput'