A plugin that simulates lift and drag.
More...
#include <LiftDragPlugin.hh>
Inherits ModelPlugin.
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name. More...
|
|
|
void | LoadParam (const sdf::ElementPtr &_sdf, const std::string &_name, V &_target, V _defaultValue=V()) const |
| Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...
|
|
void | LoadParam (sdf::ElementPtr &_sdf, const std::string &_name, std::string &_target, const char *_defaultValue) const |
| Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...
|
|
virtual void | OnUpdate () |
| Callback for World Update events. More...
|
|
A plugin that simulates lift and drag.
◆ TPtr
plugin pointer type definition
◆ LiftDragPlugin()
◆ ~LiftDragPlugin()
◆ Create()
static TPtr Create |
( |
const std::string & |
_filename, |
|
|
const std::string & |
_name |
|
) |
| |
|
inlinestaticinherited |
a class method that creates a plugin from a file name.
It locates the shared library and loads it dynamically.
- Parameters
-
[in] | _filename | the path to the shared library. |
[in] | _name | short name of the plugin |
- Returns
- Shared Pointer to this class type
References PluginT< T >::filename, gzerr, and SingletonT< SystemPaths >::Instance().
◆ GetFilename()
std::string GetFilename |
( |
| ) |
const |
|
inlineinherited |
◆ GetHandle()
std::string GetHandle |
( |
| ) |
const |
|
inlineinherited |
◆ GetType()
◆ Init()
Override this method for custom plugin initialization behavior.
Reimplemented in KeysToCmdVelPlugin, BuoyancyPlugin, HarnessPlugin, FollowerPlugin, PlaneDemoPlugin, MudPlugin, CartDemoPlugin, VehiclePlugin, GimbalSmall2dPlugin, LinearBatteryPlugin, DiffDrivePlugin, and SphereAtlasDemoPlugin.
◆ Load()
Load function.
Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.
- Parameters
-
[in] | _model | Pointer to the Model |
[in] | _sdf | Pointer to the SDF element of the plugin. |
Implements ModelPlugin.
◆ LoadParam() [1/2]
void LoadParam |
( |
const sdf::ElementPtr & |
_sdf, |
|
|
const std::string & |
_name, |
|
|
V & |
_target, |
|
|
V |
_defaultValue = V() |
|
) |
| const |
|
inlineprotectedinherited |
Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.
A message is written using gzmsg reporting whether the default value was used or not.
- Parameters
-
[in] | _sdf | The SDF element of the plugin. |
[in] | _name | Name of a tag inside the SDF. |
[out] | _target | The reference to store the param value to. |
[in] | _defaultValue | The default value. |
References gzmsg, and PluginT< T >::handleName.
◆ LoadParam() [2/2]
void LoadParam |
( |
sdf::ElementPtr & |
_sdf, |
|
|
const std::string & |
_name, |
|
|
std::string & |
_target, |
|
|
const char * |
_defaultValue |
|
) |
| const |
|
inlineprotectedinherited |
Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.
A message is written using gzmsg reporting whether the default value was used or not. String specialization to allow accepting const char* values for std::string parameters.
- Parameters
-
[in] | _sdf | The SDF element of the plugin. |
[in] | _name | Name of a tag inside the SDF. |
[out] | _target | The reference to store the param value to. |
[in] | _defaultValue | The default value. |
◆ OnUpdate()
virtual void OnUpdate |
( |
| ) |
|
|
protectedvirtual |
Callback for World Update events.
◆ Reset()
◆ alpha
◆ alpha0
◆ alphaStall
angle of attach when airfoil stalls
◆ area
effective planeform surface area
◆ cda
Coefficient of Drag / alpha slope.
Drag = C_D * q * S where q (dynamic pressure) = 0.5 * rho * v^2
◆ cdaStall
Cd-alpha rate after stall.
◆ cla
Coefficient of Lift / alpha slope.
Lift = C_L * q * S where q (dynamic pressure) = 0.5 * rho * v^2
◆ claStall
Cl-alpha rate after stall.
◆ cma
Coefficient of Moment / alpha slope.
Moment = C_M * q * S where q (dynamic pressure) = 0.5 * rho * v^2
◆ cmaStall
Cm-alpha rate after stall.
◆ controlJoint
Pointer to a joint that actuates a control surface for this lifting body.
◆ controlJointRadToCL
double controlJointRadToCL |
|
protected |
how much to change CL per radian of control surface joint value.
◆ cp
ignition::math::Vector3d cp |
|
protected |
center of pressure in link local coordinates
◆ filename
Path to the shared library file.
◆ forward
ignition::math::Vector3d forward |
|
protected |
Normally, this is taken as a direction parallel to the chord of the airfoil in zero angle of attack forward flight.
◆ handleName
◆ link
Pointer to link currently targeted by mud joint.
◆ model
Pointer to model containing plugin.
◆ physics
Pointer to physics engine.
◆ radialSymmetry
if the shape is aerodynamically radially symmetric about the forward direction.
Defaults to false for wing shapes. If set to true, the upward direction is determined by the angle of attack.
◆ rho
air density at 25 deg C it's about 1.1839 kg/m^3 At 20 °C and 101.325 kPa, dry air has a density of 1.2041 kg/m3.
◆ sdf
◆ sweep
◆ type
◆ updateConnection
Connection to World Update events.
◆ upward
ignition::math::Vector3d upward |
|
protected |
A vector in the lift/drag plane, perpendicular to the forward vector.
Inflow velocity orthogonal to forward and upward vectors is considered flow in the wing sweep direction.
◆ velocityStall
: : make a stall velocity curve
◆ velSmooth
ignition::math::Vector3d velSmooth |
|
protected |
◆ world
The documentation for this class was generated from the following file: