stormbird 0.9.0

A library for modeling modern wind propulsion devices
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

// Copyright (C) 2024, NTNU
// Author: Jarle Vinje Kramer <jarlekramer@gmail.com; jarle.a.kramer@ntnu.no>
// License: GPL v3.0 (see separate file LICENSE or https://www.gnu.org/licenses/gpl-3.0.html)


use crate::line_force_model::builder::LineForceModelBuilder;
use crate::controller::builder::ControllerBuilder;

use serde::{Serialize, Deserialize};

use stormath::spatial_vector::SpatialVector;
use stormath::type_aliases::Float;

use super::projection::ProjectionSettings;
use super::sampling::SamplingSettings;
use super::solver::SolverSettings;
use super::ActuatorLine;

use super::corrections::{
    lifting_line::LiftingLineCorrectionBuilder,
    empirical_circulation::EmpiricalCirculationCorrection,
};


#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
/// Builder for the actuator line model.
pub struct ActuatorLineBuilder {
    pub line_force_model: LineForceModelBuilder,
    #[serde(default)]
    pub projection_settings: ProjectionSettings,
    #[serde(default)]
    pub solver_settings: SolverSettings,
    #[serde(default)]
    pub sampling_settings: SamplingSettings,
    #[serde(default="ActuatorLineBuilder::default_write_iterations_full_result")]
    pub write_iterations_full_result: usize,
    #[serde(default)]
    pub start_time: Float,
    #[serde(default)]
    pub controller: Option<ControllerBuilder>,
    #[serde(default="ActuatorLineBuilder::default_lifting_line_correction")]
    pub lifting_line_correction: Option<LiftingLineCorrectionBuilder>,
    #[serde(default)]
    pub empirical_circulation_correction: Option<EmpiricalCirculationCorrection>,
}

impl ActuatorLineBuilder {
    pub fn default_write_iterations_full_result() -> usize {100}
    pub fn default_lifting_line_correction() -> Option<LiftingLineCorrectionBuilder> {
        Some(
            LiftingLineCorrectionBuilder::default()
        )
    }

    pub fn new(line_force_model: LineForceModelBuilder) -> Self {
        Self {
            line_force_model,
            projection_settings: ProjectionSettings::default(),
            solver_settings: SolverSettings::default(),
            sampling_settings: SamplingSettings::default(),
            controller: None,
            write_iterations_full_result: Self::default_write_iterations_full_result(),
            start_time: 0.0,
            lifting_line_correction: None,
            empirical_circulation_correction: None,
        }
    }

    /// Constructs a actuator line model from the builder data.
    pub fn build(&self) -> ActuatorLine {
        let line_force_model = self.line_force_model.build();

        let nr_span_lines = line_force_model.nr_span_lines();

        let controller = if let Some(controller_builder) = &self.controller {
            Some(controller_builder.build())
        } else {
            None
        };

        let lifting_line_correction = if let Some(lifting_line_correction_builder) = &self.lifting_line_correction {
            let viscous_core_length_factor = 0.5 * (
                self.projection_settings.projection_function.chord_factor +
                self.projection_settings.projection_function.thickness_factor
            );

            Some(
                lifting_line_correction_builder.build(viscous_core_length_factor, &line_force_model)
            )
        } else {
            None
        };

        ActuatorLine{
            line_force_model,
            projection_settings: self.projection_settings.clone(),
            solver_settings: self.solver_settings.clone(),
            sampling_settings: self.sampling_settings.clone(),
            controller,
            start_time: self.start_time,
            current_iteration: 0,
            write_iterations_full_result: self.write_iterations_full_result,
            ctrl_points_velocity: vec![SpatialVector::default(); nr_span_lines],
            simulation_result: None,
            sectional_lift_forces_to_project: vec![SpatialVector::default(); nr_span_lines],
            sectional_drag_forces_to_project: vec![SpatialVector::default(); nr_span_lines],
            lifting_line_correction,
            empirical_circulation_correction: self.empirical_circulation_correction.clone(),
        }
    }
}