ControllerBuilder Class Reference

Kynema-FMB API: kynema_fmb::interfaces::components::ControllerBuilder Class Reference
Kynema-FMB API
A flexible multibody structural dynamics code for wind turbines
Loading...
Searching...
No Matches
kynema_fmb::interfaces::components::ControllerBuilder Class Reference

#include <controller_builder.hpp>

Public Member Functions

ControllerInputInput ()
 
ControllerBuilderEnableController (bool enable=true)
 
ControllerBuilderEnablePitchControl (bool enable=true)
 
ControllerBuilderEnableTorqueControl (bool enable=true)
 
ControllerBuilderSetTimeStep (double time_step)
 
ControllerBuilderSetNumberOfBlades (size_t n_blades)
 
ControllerBuilderEnableYawControl (bool enable=true)
 
ControllerBuilderSetYawAngle (double angle)
 
ControllerBuilderSetPitchAngle (double angle)
 
ControllerBuilderEnableReadCheckpoint (bool enable=true)
 Set flag to enable reading of checkpoint file for restart.
 
ControllerBuilderSetLibraryPath (std::string_view lib_path)
 Set library path for the controller.
 
ControllerBuilderSetFunctionName (std::string_view func_name)
 Set function name for the controller.
 
ControllerBuilderSetInputFilePath (std::string_view inp_file_path)
 Set input file path for the controller.
 
ControllerBuilderSetOutputFilePath (std::string_view sim_name)
 Set output file path for the controller.
 

Member Function Documentation

◆ EnableController()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::EnableController ( bool  enable = true)
inline

◆ EnablePitchControl()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::EnablePitchControl ( bool  enable = true)
inline

◆ EnableReadCheckpoint()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::EnableReadCheckpoint ( bool  enable = true)
inline

Set flag to enable reading of checkpoint file for restart.

◆ EnableTorqueControl()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::EnableTorqueControl ( bool  enable = true)
inline

◆ EnableYawControl()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::EnableYawControl ( bool  enable = true)
inline

◆ Input()

ControllerInput & kynema_fmb::interfaces::components::ControllerBuilder::Input ( )
inline

◆ SetFunctionName()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::SetFunctionName ( std::string_view  func_name)
inline

Set function name for the controller.

◆ SetInputFilePath()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::SetInputFilePath ( std::string_view  inp_file_path)
inline

Set input file path for the controller.

◆ SetLibraryPath()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::SetLibraryPath ( std::string_view  lib_path)
inline

Set library path for the controller.

◆ SetNumberOfBlades()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::SetNumberOfBlades ( size_t  n_blades)
inline

◆ SetOutputFilePath()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::SetOutputFilePath ( std::string_view  sim_name)
inline

Set output file path for the controller.

◆ SetPitchAngle()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::SetPitchAngle ( double  angle)
inline

◆ SetTimeStep()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::SetTimeStep ( double  time_step)
inline

◆ SetYawAngle()

ControllerBuilder & kynema_fmb::interfaces::components::ControllerBuilder::SetYawAngle ( double  angle)
inline

The documentation for this class was generated from the following file: