Observer

Observer#

class Observer[source]#

Bases: Flow360BaseModel

Example

>>> fl.Observer(position=[1, 2, 3] * fl.u.m, group_name="1")

Attributes

position: LengthType.Vector#: Position at which time history of acoustic pressure signal is stored in aeroacoustic output file. The observer position can be outside the simulation domain, but cannot be on or inside the solid surfaces of the simulation domain.

group_name: str#: Name of the group to which the observer will be assigned for postprocessing purposes in Flow360 web client.

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') 