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'

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

List of permeable surfaces. Left empty if patch_type is solid

Default:

None

observers: list[Observer]

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

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: TimeType.Positive, optional

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.

Default:

None

aeroacoustic_solver_start_time: TimeType.NonNegative

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

Default:

0 * s

force_clean_start: bool

Force a clean start when an aeroacoustic case is forked.

Default:

False

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')