Skip to content

Commit a38c57e

Browse files
committed
Improve docu of solve()
1 parent e40eee8 commit a38c57e

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

docs/src/functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ CurrentModule = VortexStepMethod
66
add_section!
77
```
88

9-
## Functions for setting the inflow conditions and solving
9+
## Setting the inflow conditions and solving
1010
```@docs
1111
set_va!
1212
solve

src/solver.jl

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,24 @@ struct Solver
7575
end
7676

7777
"""
78-
solve(solver::Solver, body_aero::BodyAerodynamics, gamma_distribution=nothing; log=false, reference_point=zeros(MVec3))
78+
solve(solver::Solver, body_aero::BodyAerodynamics, gamma_distribution=nothing;
79+
log=false, reference_point=zeros(MVec3))
7980
8081
Main solving routine for the aerodynamic model. Reference point is in the kite body (KB) frame.
82+
83+
# Arguments:
84+
- solver::Solver: The solver to use, could be a VSM or LLT solver. See: [Solver](@ref)
85+
- body_aero::BodyAerodynamics: The aerodynamic body. See: [BodyAerodynamics](@ref)
86+
- gamma_distribution
87+
88+
# Keyword Arguments:
89+
- log=false: If true, print the number of iterations and other info.
90+
- reference_point=zeros(MVec3)
8191
"""
82-
function solve(solver::Solver, body_aero::BodyAerodynamics, gamma_distribution=nothing; log=false, reference_point=zeros(MVec3))
92+
function solve(solver::Solver, body_aero::BodyAerodynamics, gamma_distribution=nothing;
93+
log=false, reference_point=zeros(MVec3))
94+
95+
# check arguments
8396
isnothing(body_aero.panels[1].va) && throw(ArgumentError("Inflow conditions are not set, use set_va!(body_aero, va)"))
8497

8598
# Initialize variables

0 commit comments

Comments
 (0)