turbine_interface.hpp

Go to the documentation of this file.

#pragma once
 
#include "interfaces/components/aerodynamics.hpp"
#include "interfaces/components/aerodynamics_input.hpp"
#include "interfaces/components/controller.hpp"
#include "interfaces/components/controller_input.hpp"
#include "interfaces/components/outputs_config.hpp"
#include "interfaces/components/turbine.hpp"
#include "interfaces/host_constraints.hpp"
#include "interfaces/host_state.hpp"
#include "interfaces/outputs.hpp"
#include "model/model.hpp"
#include "step/step_parameters.hpp"
 
namespace kynema_fmb::interfaces::components {
struct SolutionInput;
struct TurbineInput;
struct OutputsConfig;
}  // namespace kynema_fmb::interfaces::components
 
namespace kynema_fmb::interfaces {
 
class TurbineInterface {
public:
    using DeviceType =
        Kokkos::Device<Kokkos::DefaultExecutionSpace, Kokkos::DefaultExecutionSpace::memory_space>;
 
    explicit TurbineInterface(
        const components::SolutionInput& solution_input,
        const components::TurbineInput& turbine_input,
        const components::AerodynamicsInput& aerodynamics_input = {},
        const components::ControllerInput& controller_input = {},
        const components::OutputsConfig& outputs_config = {}
    );
 
    TurbineInterface(TurbineInterface& other) = delete;
 
    TurbineInterface(TurbineInterface&& other) = delete;
 
    TurbineInterface& operator=(const TurbineInterface&) = delete;
 
    TurbineInterface& operator=(TurbineInterface&&) = delete;
 
    ~TurbineInterface() = default;
 
    [[nodiscard]] components::Turbine& Turbine() { return this->turbine; }
 
    [[nodiscard]] components::Aerodynamics& Aerodynamics() {
        if (!aerodynamics) {
            throw std::runtime_error("Aerodynamics component not initialized in TurbineInterface.");
        }
        return *aerodynamics;
    }
 
    void UpdateAerodynamicLoads(
        double fluid_density,
        const std::function<std::array<double, 3>(const std::array<double, 3>&)>& inflow_function
    );
 
    std::array<double, 3> GetHubNodePosition() const;
 
    void SetHubInflow(const std::array<double, 3>& inflow);
 
    void ApplyController(double t);
 
    [[nodiscard]] bool Step();
 
    void SaveState();
 
    void RestoreState();
 
    Model& GetModel() { return model; }
 
    HostState<DeviceType>& GetHostState() { return host_state; }
 
    [[nodiscard]] double CalculateAzimuthAngle() const;
 
    [[nodiscard]] double CalculateRotorSpeed() const;
 
    void WriteOutput();
 
    void OpenOutputFile();
 
    void CloseOutputFile();
 
    void WriteCheckpointFile(const std::string& file_path) const;
 
    void ReadCheckpointFile(const std::string& file_path);
 
    void SetTimeStepIndex(size_t idx) { this->state.time_step = idx; }
 
private:
    Model model;                    
    components::Turbine turbine;    
    State<DeviceType> state;        
    Elements<DeviceType> elements;  
    Constraints<DeviceType>
        constraints;                   
    StepParameters parameters;         
    Solver<DeviceType> solver;         
    State<DeviceType> state_save;      
    HostState<DeviceType> host_state;  
    HostConstraints<DeviceType> host_constraints;        
    std::unique_ptr<Outputs> outputs;                    
    std::unique_ptr<components::Controller> controller;  
    std::unique_ptr<components::Aerodynamics> aerodynamics;  
    std::array<double, 3> hub_inflow{0., 0., 0.};            
    double gearbox_ratio{1.0};                               
    double generator_efficiency{1.0};                        
 
    void WriteTimeSeriesData();
 
    void InitializeController(const components::TurbineInput& turbine_input);
 
    //------------------------------------------
    // support for time-series outputs
    //------------------------------------------
 
    struct TimeSeriesIndexMap {
        // Basic simulation parameter and other misc. channels
        size_t time_seconds{};                //< Time in seconds
        size_t num_convergence_iterations{};  //< Number of convergence iterations
        size_t convergence_error{};           //< Last convergence error
        size_t azimuth_angle_degrees{};       //< Azimuth angle in degrees
        size_t rotor_speed_rpm{};             //< Rotor speed in RPM
 
        // Yaw position channel
        size_t yaw_position_degrees{};  //< Yaw position in degrees
 
        // Tower top and base state channels (contiguous groups, 3 entries each)
        size_t tower_top_displacement_start{};  //< Start of [x, y, z] displacement
        size_t tower_top_velocity_start{};      //< Start of [x, y, z] velocity
        size_t tower_top_acceleration_start{};  //< Start of [x, y, z] acceleration
        size_t tower_base_force_start{};        //< Start of [Fx, Fy, Fz] forces
        size_t tower_base_moment_start{};       //< Start of [Mx, My, Mz] moments
 
        // Rotor thrust channel
        size_t rotor_thrust_kN{};  //< Thrust in kiloNewtons
 
        // Blade data channels (dynamic per blade: root forces and moments, pitch angle, tip
        // velocities and rotational velocities)
        static constexpr size_t kBladeChannelStride{13};  //< Channels per blade
        std::vector<size_t> blade_channel_offsets;        //< Base offset per blade
 
        // Controller channels (optional: generator torque and power)
        bool has_controller_channels{false};  //< True if controller channels are present
        size_t generator_torque_kNm{};        //< Generator torque in kiloNewton-meters
        size_t generator_power_kW{};          //< Generator power in kiloWatts
 
        // Hub inflow valocity channels
        size_t hub_inflow_start{};  //< Start of [x, y, z] inflow velocity
 
        // Aerodynamic channels (dynamic per blade and section:
        // relative velocity, angle of attack, lift coefficient, drag coefficient, moment
        // coefficient, force in x-direction, forces (3) and moments (3)
        static constexpr size_t kAeroChannelStride{11};  //< Vrel, Alpha, Cn, Ct, Cm, Fxi-Mzi
        std::vector<size_t> aero_body_offsets;           //< Base offset per body
        std::vector<size_t> aero_section_counts;         //< Number of sections per body
    };
 
    bool time_series_enabled_{false};
    std::vector<std::string> time_series_channels_;
    TimeSeriesIndexMap index_map_{};
    std::vector<double> time_series_row_buffer_;
 
    void BuildTimeSeriesSchema();
};
 
}  // namespace kynema_fmb::interfaces