Skip to content

Commit b54449e

Browse files
committed
Update docu
1 parent 81494ad commit b54449e

File tree

2 files changed

+60
-9
lines changed

2 files changed

+60
-9
lines changed

docs/src/ram_air_kite.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@
22
CurrentModule = KiteModels
33
```
44
## Introduction
5-
The RamAirKite is based on ModelingToolkit, which allows to define the differential algebraic equations in symbolic form.
5+
The [`RamAirKite`](@ref) is based on ModelingToolkit, which allows to define the differential algebraic equations in symbolic form. It does not use a KCU. Instead, the kite is controlled from the ground (e.g. a ship) using three winches and four tethers.
66

7-
## Types
7+
## Private enumerations
8+
```@docs
9+
SegmentType
10+
DynamicsType
11+
```
12+
13+
## Private types
814
```@docs
915
Point
1016
Pulley
@@ -14,7 +20,7 @@ Winch
1420
KitePointGroup
1521
```
1622

17-
## Functions
23+
## Private functions
1824
```@docs
1925
create_sys!
2026
diff_eqs!

src/ram_air_kite.jl

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,33 @@ function Base.getproperty(m::Measurement, val::Symbol)
5959
end
6060
end
6161

62+
"""
63+
SegmentType `POWER` `STEERING` `BRIDLE`
64+
65+
Type of segment.
66+
67+
# Elements
68+
- POWER: Belongs to a power line
69+
- STEERING: Belongs to a steering line
70+
- BRIDLE: Belongs to the bridle
71+
"""
6272
@enum SegmentType begin
6373
POWER
6474
STEERING
6575
BRIDLE
6676
end
6777

78+
"""
79+
DynamicsType `DYNAMIC` `STATIC` `KITE` `WINCH`
80+
81+
Enumeration of the models that are attached to a point.
82+
83+
# Elements
84+
- DYNAMIC: Belongs to a dynamic tether model
85+
- STATIC: Belongs to a static tether model
86+
- KITE: Rigid body
87+
- WINCH: Winch
88+
"""
6889
@enum DynamicsType begin
6990
DYNAMIC
7091
STATIC
@@ -73,7 +94,11 @@ end
7394
end
7495

7596
"""
76-
A normal freely moving tether point
97+
mutable struct Point
98+
99+
A normal freely moving tether point.
100+
101+
$(TYPEDFIELDS)
77102
"""
78103
mutable struct Point
79104
idx::Int16
@@ -86,7 +111,11 @@ function Point(idx, pos_b, type)
86111
end
87112

88113
"""
89-
Set of bridle lines that share the same twist angle and trailing edge angle
114+
struct KitePointGroup
115+
116+
Set of bridle lines that share the same twist angle and trailing edge angle.
117+
118+
$(TYPEDFIELDS)
90119
"""
91120
struct KitePointGroup
92121
idx::Int16
@@ -98,7 +127,11 @@ struct KitePointGroup
98127
end
99128

100129
"""
101-
A segment from one point index to another point index
130+
mutable struct Segment
131+
132+
A segment from one point index to another point index.
133+
134+
$(TYPEDFIELDS)
102135
"""
103136
mutable struct Segment
104137
idx::Int16
@@ -115,7 +148,11 @@ function Segment(idx, points, type, l0)
115148
end
116149

117150
"""
118-
A pulley described by two segments with the common point of the segments being the pulley
151+
mutable struct Pulley
152+
153+
A pulley described by two segments with the common point of the segments being the pulley.
154+
155+
$(TYPEDFIELDS)
119156
"""
120157
mutable struct Pulley
121158
idx::Int16
@@ -128,7 +165,11 @@ mutable struct Pulley
128165
end
129166

130167
"""
168+
struct Tether
169+
131170
A set of segments making a flexible tether. The winch point should only be part of one segment.
171+
172+
$(TYPEDFIELDS)
132173
"""
133174
struct Tether
134175
idx::Int16
@@ -137,7 +178,11 @@ struct Tether
137178
end
138179

139180
"""
140-
A set of tethers or just one tether connected to a winch
181+
mutable struct Winch
182+
183+
A set of tethers or just one tether connected to a winch.
184+
185+
$(TYPEDFIELDS)
141186
"""
142187
mutable struct Winch
143188
idx::Int16
@@ -180,7 +225,7 @@ struct PointMassSystem
180225
end
181226

182227
"""
183-
mutable struct RamAirKite{S, T, P, Q, SP} <: AbstractKiteModel
228+
mutable struct RamAirKite{S, V, P} <: AbstractKiteModel
184229
185230
State of the kite power system, using a quaternion kite model and three steering lines to the ground. Parameters:
186231
- S: Scalar type, e.g. SimFloat

0 commit comments

Comments
 (0)