pyaedt.modeler.actors.Bird

class pyaedt.modeler.actors.Bird(bird_folder, speed='2.0', flapping_rate='50Hz', relative_cs_name=None)[source]

Provides an instance of a bird.

This class is derived from pyaedt.modeler.multiparts.MultiPartComponent.

Note

Motion is always forward in the X-axis direction.

Parameters
bird_folderstr

Full path to the directory containing the definition of the bird. This can be changed later.

speedfloat or str, optional

Speed of the bird. The default is "2.0".

flapping_ratefloat or str, optional

Flapping rate. The default is "50Hz".

relative_cs_namestr, optional

Name of the relative coordinate system of the actor. The default is``None``, in which case the global coordinate system is used.

Methods

Bird.insert(app[, motion])

Insert the bird in HFSS SBR+.

Bird.position_in_app(app)

Set up design variables and values to enable motion for the multi-part 3D component.

Bird.start(app)

Initialize app for SBR+ simulation.

Attributes

Bird.cs_name

Coordinate system name.

Bird.index

Number of multi-part components.

Bird.modeler_units

Bird.name

Unique instance name.

Bird.offset

Offset values for the multi-part component.

Bird.offset_names

X-, Y-, and Z-axis offset names.

Bird.offset_x_name

X-axis offset name.

Bird.offset_y_name

Y-axis offset name.

Bird.offset_z_name

Z-axis offset name.

Bird.pitch

Pitch variable value.

Bird.pitch_name

Pitch variable name.

Bird.roll

Roll variable value.

Bird.roll_name

Roll variable name.

Bird.speed_expression

Speed variable expression.

Bird.speed_name

Speed variable name.

Bird.use_global_cs

Global coordinate system.

Bird.yaw

Yaw variable value.

Bird.yaw_name

Yaw variable name.