Skip to content

Commit 6360cda

Browse files
committed
improve docstrings
1 parent 10b8f5a commit 6360cda

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

docs/src/functions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ CurrentModule = VortexStepMethod
66
add_section!
77
```
88

9+
## Functions for setting the inflow conditions
10+
```@docs
11+
set_va!
12+
```
13+
914
## Main Plotting Functions
1015
```@docs
1116
plot_geometry

docs/src/types.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,8 @@ CurrentModule = VortexStepMethod
1717
PanelProperties
1818
BodyAerodynamics
1919
```
20+
21+
## The Solver
22+
```@docs
23+
Solver
24+
```

src/solver.jl

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,26 @@
33
Solver
44
55
Main solver structure for the Vortex Step Method.
6+
7+
# Attributes
8+
9+
## General settings
10+
- `aerodynamic_model_type`::Symbol
11+
- density::Float64
12+
- `max_iterations`::Int64
13+
- `allowed_error`::Float64
14+
- `tol_reference_error`::Float64
15+
- `relaxation_factor`::Float64
16+
17+
## Damping settings
18+
- `is_with_artificial_damping`::Bool
19+
- `artificial_damping`::NamedTuple{(:k2, :k4), Tuple{Float64, Float64}}
20+
21+
## Additional settings
22+
- `type_initial_gamma_distribution`::Symbol
23+
- `core_radius_fraction`::Float64
24+
- mu::Float64
25+
- `is_only_f_and_gamma_output`::Bool
626
"""
727
struct Solver
828
# General settings

0 commit comments

Comments
 (0)