Skip to content

Commit f0e240c

Browse files
committed
clean up docstrings
1 parent d848d0f commit f0e240c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/utilities/options.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -501,14 +501,14 @@ end
501501
"""
502502
struct GridSolverOptions{TB,TF,TI,TSym} <: GridSolverOptionsType
503503
504-
Options for Newton elliptic grid solver.
504+
Options for SLOR + Newton elliptic grid solver.
505505
506506
# Fields
507507
- `iteration_limit::TI = 10` : maximum number of iterations
508508
- `atol::TF = 1e-14` : absolute convergence tolerance
509509
- `algorithm::TSym = :newton` : algorithm to use in NLsolve.jl
510510
- `autodiff::TSym = :forward` : differentiation method to use in NLsolve.jl
511-
- `converged::AbstractVector{TB} = [false]
511+
- `converged::AbstractVector{TB}` = [false]
512512
"""
513513
@kwdef struct GridSolverOptions{TB,TF,TI,TSym} <: GridSolverOptionsType
514514
iteration_limit::TI = 20
@@ -544,7 +544,8 @@ Type containing (nearly) all the available user options.
544544
- `verbose::TB = false` : flag to print verbose statements
545545
- `silence_warnings::TB = true` : flag to silence warnings
546546
- `multipoint_index::TI = [1]` : holds current index of multi-point solver (no need for user to change this usually)
547-
## Geometry Re-interpolation and generation options` :
547+
## Pre-processing Options
548+
### Geometry ee-interpolation and generation options :
548549
- `finterp::Tin = FLOWMath.akima` : interpolation method used for re-paneling bodies
549550
- `autoshiftduct::TB = true` : flag as to whether duct geometry should be shifted based on rotor tip location
550551
- `lu_decomp_flag::TB = false` : flag indicating if panel method LHS matrix factorization was successful

0 commit comments

Comments
 (0)