Skip to content

Commit

Permalink
clean up docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
juddmehr committed Jun 26, 2024
1 parent d848d0f commit f0e240c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/utilities/options.jl
Original file line number Diff line number Diff line change
Expand Up @@ -501,14 +501,14 @@ end
"""
struct GridSolverOptions{TB,TF,TI,TSym} <: GridSolverOptionsType
Options for Newton elliptic grid solver.
Options for SLOR + Newton elliptic grid solver.
# Fields
- `iteration_limit::TI = 10` : maximum number of iterations
- `atol::TF = 1e-14` : absolute convergence tolerance
- `algorithm::TSym = :newton` : algorithm to use in NLsolve.jl
- `autodiff::TSym = :forward` : differentiation method to use in NLsolve.jl
- `converged::AbstractVector{TB} = [false]
- `converged::AbstractVector{TB}` = [false]
"""
@kwdef struct GridSolverOptions{TB,TF,TI,TSym} <: GridSolverOptionsType
iteration_limit::TI = 20
Expand Down Expand Up @@ -544,7 +544,8 @@ Type containing (nearly) all the available user options.
- `verbose::TB = false` : flag to print verbose statements
- `silence_warnings::TB = true` : flag to silence warnings
- `multipoint_index::TI = [1]` : holds current index of multi-point solver (no need for user to change this usually)
## Geometry Re-interpolation and generation options` :
## Pre-processing Options
### Geometry ee-interpolation and generation options :
- `finterp::Tin = FLOWMath.akima` : interpolation method used for re-paneling bodies
- `autoshiftduct::TB = true` : flag as to whether duct geometry should be shifted based on rotor tip location
- `lu_decomp_flag::TB = false` : flag indicating if panel method LHS matrix factorization was successful
Expand Down

0 comments on commit f0e240c

Please sign in to comment.