Controller Class Reference
|
Kynema-FMB API
A flexible multibody structural dynamics code for wind turbines
|
#include <controller.hpp>
Public Member Functions | |
| Controller (const ControllerInput &input) | |
| Constructor for the Controller class. | |
| void | CallController () |
| Method to call the controller function from the shared library. | |
| double | PitchAngleCommand () const |
| Get the collective commanded pitch angle (rad) | |
| std::array< double, 3 > | PitchAngleCommandIndividual () const |
| Get the commanded individual pitch angle (rad) | |
| double | GeneratorTorqueCommand () const |
| Get the commanded generator torque (Nm) | |
| double | YawAngleCommand () const |
| Get the commanded yaw angle (rad) integrated from yaw rate command. | |
| void | SetStatusInit () |
| Set the controller status to initialization. | |
| void | SetStatusOperating () |
| Set the controller status to operating. | |
| void | SetStatusWriteCheckpoint () |
| Set the controller status to write checkpoint file (only valid for ROSCO controller) | |
| void | SetStatusReadCheckpoint () |
| Set the controller status to read checkpoint file (only valid for ROSCO controller) | |
| void | SetSimulationTime (double simulation_time) |
| Set the simulation time (s) | |
| void | SetSimulationTimeStep (double simulation_time_step) |
| Set the simulation time step (s) | |
| void | SetYawAngle (double yaw_angle) |
| Set the measured yaw angle (rad) | |
| void | SetRotorSpeed (double rotor_speed) |
| Set the measured rotor speed (rad/s) | |
| void | SetGeneratorSpeed (double generator_speed) |
| Set the measured generator speed (rad/s) | |
| void | SetGeneratorTorque (double generator_torque) |
| Set the measured generator torque (Nm) | |
| void | SetGeneratorPower (double generator_power) |
| Set measured generator power (W) | |
| void | SetWindSpeed (double wind_speed) |
| Set measured wind speed at hub (m/s) | |
| void | SetRotorAzimuth (double rotor_azimuth) |
| Set the rotor azimuth angle (rad) | |
| void | SetBladePitch (double blade_pitch_collective) |
| Set measured blade pitch angle (rad) | |
| void | SetBladePitch (std::array< double, 3 > blade_pitch) |
| Set measured blade pitch angle (rad) | |
| void | SetOutOfPlaneRootBendingMoment (std::array< double, 3 > root_moment) |
| Set measured out-of-plane root bending moment for each blade (Nm) | |
Detailed Description
A turbine controller class that works as a wrapper around the shared library containing the controller logic
Constructor & Destructor Documentation
◆ Controller()
|
explicit |
Constructor for the Controller class.
- Parameters
-
input Controller input parameters structure
Member Function Documentation
◆ CallController()
| void kynema_fmb::interfaces::components::Controller::CallController | ( | ) |
Method to call the controller function from the shared library.
◆ GeneratorTorqueCommand()
|
inline |
Get the commanded generator torque (Nm)
◆ PitchAngleCommand()
|
inline |
Get the collective commanded pitch angle (rad)
◆ PitchAngleCommandIndividual()
|
inline |
Get the commanded individual pitch angle (rad)
◆ SetBladePitch() [1/2]
|
inline |
Set measured blade pitch angle (rad)
◆ SetBladePitch() [2/2]
|
inline |
Set measured blade pitch angle (rad)
◆ SetGeneratorPower()
|
inline |
Set measured generator power (W)
◆ SetGeneratorSpeed()
|
inline |
Set the measured generator speed (rad/s)
◆ SetGeneratorTorque()
|
inline |
Set the measured generator torque (Nm)
◆ SetOutOfPlaneRootBendingMoment()
|
inline |
Set measured out-of-plane root bending moment for each blade (Nm)
◆ SetRotorAzimuth()
|
inline |
Set the rotor azimuth angle (rad)
◆ SetRotorSpeed()
|
inline |
Set the measured rotor speed (rad/s)
◆ SetSimulationTime()
|
inline |
Set the simulation time (s)
◆ SetSimulationTimeStep()
|
inline |
Set the simulation time step (s)
◆ SetStatusInit()
|
inline |
Set the controller status to initialization.
◆ SetStatusOperating()
|
inline |
Set the controller status to operating.
◆ SetStatusReadCheckpoint()
|
inline |
Set the controller status to read checkpoint file (only valid for ROSCO controller)
◆ SetStatusWriteCheckpoint()
|
inline |
Set the controller status to write checkpoint file (only valid for ROSCO controller)
◆ SetWindSpeed()
|
inline |
Set measured wind speed at hub (m/s)
◆ SetYawAngle()
|
inline |
Set the measured yaw angle (rad)
◆ YawAngleCommand()
|
inline |
Get the commanded yaw angle (rad) integrated from yaw rate command.
The documentation for this class was generated from the following files:
- /home/runner/work/kynema-fmb/kynema-fmb/kynema-fmb/src/interfaces/components/controller.hpp
- /home/runner/work/kynema-fmb/kynema-fmb/kynema-fmb/src/interfaces/components/controller.cpp
Generated by