clean up pre-processing docstrings

byuflowlab · Apr 20, 2024 · 9d57748 · 9d57748
1 parent 9976508
commit 9d57748
Show file tree

Hide file tree

Showing 2 changed files with 108 additions and 16 deletions.
diff --git a/docs/src/DuctAPE/api.md b/docs/src/DuctAPE/api.md
@@ -7,23 +7,88 @@ Depth = 5
 
 ## Public API
 
+### Input Types
+```@docs
+DuctAPE.Propulsor
+DuctAPE.RotorStatorParameters
+DuctAPE.OperatingPoint
+DuctAPE.PanelingConstants
+DuctAPE.ReferenceParameters
+```
+
 ### Options
 
+#### General Options
 ```@docs
+DuctAPE.Options
 DuctAPE.set_options
-DuctAPE.DFDC_options
 ```
 
-### Setup
+#### Integration Options
+```@docs
+DuctAPE.IntegrationOptions
+DuctAPE.GaussLegendre
+DuctAPE.GaussKronrod
+DuctAPE.Romberg
+```
+
+#### Solver Options
 
+##### Elliptic Grid Solve
 ```@docs
-DuctAPE.setup_analysis
+DuctAPE.SLORGridSolverOptions
+DuctAPE.GridSolverOptions
+```
+
+##### Aero Solve
+```@docs
+DuctAPE.ChainSolverOptions
+DuctAPE.CompositeSolverOptions
+DuctAPE.NLsolveOptions
+DuctAPE.NonlinearSolveOptions
+DuctAPE.MinpackOptions
+DuctAPE.SIAMFANLEOptions
+DuctAPE.SpeedMappingOptions
+DuctAPE.FixedPointOptions
+DuctAPE.CSORSolverOptions
 ```
 
 ### Analysis
+```@docs
+DuctAPE.analyze
+```
+
+### Preprocess
+
+```@docs
+DuctAPE.setup_analysis
+```
+### Process
+
+### Postprocess
+
+
+
+
+
+----------------------------------------------------
+
 
 ## Private API
 
+### Option Types
+```@docs
+DuctAPE.DFDC_options
+DuctAPE.ConvergenceType
+DuctAPE.Relative
+DuctAPE.Absolute
+DuctAPE.SolverOptionsType
+DuctAPE.ExternalSolverOptions
+DuctAPE.PolyAlgorithmOptions
+DuctAPE.GridSolverOptionsType
+DuctAPE.IntegrationMethod
+```
+
 ### Bookkeeping
 ```@docs
 DuctAPE.get_problem_dimensions
@@ -54,10 +119,24 @@ DuctAPE.withdraw_solve_parameter_cache
 DuctAPE.withdraw_solve_container_cache
 ```
 
+### Preprocess
+```@docs
+DuctAPE.reinterpolate_geometry
+DuctAPE.reinterpolate_geometry!
+DuctAPE.generate_all_panels
+DuctAPE.generate_all_panels!
+DuctAPE.calculate_unit_induced_velocities
+DuctAPE.calculate_unit_induced_velocities!
+DuctAPE.initialize_linear_system
+DuctAPE.initialize_linear_system!
+DuctAPE.set_index_maps
+DuctAPE.precompute_parameters
+DuctAPE.precompute_parameters!
+```
 
 ### Analysis
 ```@docs
-DuctAPE.analyze
+DuctAPE.analyze_multipoint
 ```
 
 ### Post-process

diff --git a/src/preprocess/preprocess.jl b/src/preprocess/preprocess.jl
@@ -762,7 +762,20 @@ function initialize_linear_system(
 end
 
 
+"""
+    initialize_linear_system!(
+        linsys,
+        ivb,
+        body_vortex_panels,
+        rotor_source_panels,
+        wake_vortex_panels,
+        Vinf,
+        intermediate_containers,
+        integration_options,
+    )
 
+In-place version of initialize_linear_system.
+"""
 function initialize_linear_system!(
     linsys,
     ivb,
@@ -930,18 +943,18 @@ end
 Set values for index map to be used throughout solve and post-process.
 
 # Arguments
-- `npanels` : paneling_constants.npanels
-- `ncenterbody_inlet` : paneling_constants.ncenterbody_inlet
-- `nwake_sheets` : paneling_constants.nwake_sheets
-- `dte_minus_cbte` : paneling_constants.dte_minus_cbte
-- `wnm` : wake_vortex_panels.nodemap
-- `wenids` : wake_vortex_panels.endnodeidxs
-- `nwp` :  problem_dimensions.nwp
-- `nwsp` : problem_dimensions.nwsp
-- `nbn` : problem_dimensions.nbn
-- `ndp` : body_vortex_panels.npanel[1]
-- `riiw` : rotor_indices_in_wake
-- `nrotor` : problem_dimensions.nrotor
+- `npanels : paneling_constants.npanels`
+- `ncenterbody_inlet : paneling_constants.ncenterbody_inlet`
+- `nwake_sheets : paneling_constants.nwake_sheets`
+- `dte_minus_cbte : paneling_constants.dte_minus_cbte`
+- `wnm : wake_vortex_panels.nodemap`
+- `wenids : wake_vortex_panels.endnodeidxs`
+- `nwp :  problem_dimensions.nwp`
+- `nwsp : problem_dimensions.nwsp`
+- `nbn : problem_dimensions.nbn`
+- `ndp : body_vortex_panels.npanel[1]`
+- `riiw : rotor_indices_in_wake`
+- `nrotor : problem_dimensions.nrotor`
 
 # Returns
 - `idmaps::NamedTuple` : A named tuple containing index mapping used in bookkeeping throughout solve and post-process