Merge pull request #181 from cibinjoseph/cibin

Add temporary api docs with files
byuflowlab · Jun 17, 2024 · f3fa329 · f3fa329
2 parents 9f6b5b7 + f6d7f6b
commit f3fa329
Show file tree

Hide file tree

Showing 6 changed files with 68 additions and 7 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -65,7 +65,12 @@ makedocs(
                                     "theory/validation.md"
                                     "theory/publications.md"
                                    ],
-#                 "API Guide"     => [
+                "API Guide"     => [
+                                    "api/initializer.md",
+                                    "api/state.md",
+                                    "api/integrator.md",
+                                    "api/model.md",
+                                    "api/postprocessing.md",
 #                                     "(1) Vehicle Definition" => [
 #                                                                 "api/flowunsteady-vehicle-types.md",
 #                                                                 "api/flowunsteady-vehicle-components.md",
@@ -76,11 +81,8 @@ makedocs(
 #                                     "api/flowunsteady-simulation.md",
 #                                     "api/flowunsteady-monitor.md",
 #                                     "api/flowunsteady-run.md",
-#                                     "(6) Viz and Postprocessing" => [
-#                                                                 "api/flowunsteady-postprocessing-fdom.md",
-#                                                                 "api/flowunsteady-postprocessing-noise.md",
-#                                                                 "api/flowunsteady-postprocessing-misc.md",
-#                                                                 ],
+#                                   "Viz and Postprocessing" => [
+#                                                               ],
 #                                     "Extras" => [
 #                                                 "FLOWVPM"  => [
 #                                                                 "api/flowvpm-particle.md",
@@ -92,7 +94,7 @@ makedocs(
 #                                                                 "api/flowvpm-utils.md",
 #                                                                ]
 #                                                 ]
-#                                    ],
+                                   ],
             ]
 )
 

diff --git a/docs/src/api/initializer.md b/docs/src/api/initializer.md
@@ -0,0 +1,6 @@
+# initializer.jl
+
+```@docs
+FLOWUnsteady.AbstractInitializer
+FLOWUnsteady.DefaultInitializer
+```
diff --git a/docs/src/api/integrator.md b/docs/src/api/integrator.md
@@ -0,0 +1,4 @@
+# integrator.jl
+
+```@docs
+```
diff --git a/docs/src/api/model.md b/docs/src/api/model.md
@@ -0,0 +1,21 @@
+# model.jl
+
+```@docs
+FLOWUnsteady.AbstractModel
+FLOWUnsteady.AbstractBoundaryElementModel
+FLOWUnsteady.force
+FLOWUnsteady.force!
+FLOWUnsteady.solve!
+FLOWUnsteady.prepare_wake_on_all!
+FLOWUnsteady.wake_on_all!
+FLOWUnsteady.solve_boundary!
+FLOWUnsteady.prepare_surface_on_all!
+FLOWUnsteady.surface_on_all!
+FLOWUnsteady.shed_wake!
+FLOWUnsteady.forces!
+FLOWUnsteady.VortexParticleModel
+FLOWUnsteady.VortexLatticeModel
+FLOWUnsteady.add_line!
+FLOWUnsteady.update_probes_te!
+FLOWUnsteady.apply!
+```
diff --git a/docs/src/api/postprocessing.md b/docs/src/api/postprocessing.md
@@ -0,0 +1,8 @@
+# postprocessor.jl
+
+```@docs
+FLOWUnsteady.AbstractPostprocessor
+FLOWUnsteady.History
+FLOWUnsteady.ParaviewOutput
+FLOWUnsteady.MultiPostprocessor
+```
diff --git a/docs/src/api/state.md b/docs/src/api/state.md
@@ -0,0 +1,20 @@
+# state.jl
+
+```@docs
+FLOWUnsteady.RigidBodyState
+FLOWUnsteady.add_substate!
+FLOWUnsteady.get_substate
+FLOWUnsteady.get_state
+FLOWUnsteady.set_substate!
+FLOWUnsteady.set_state!
+FLOWUnsteady.set_dynamic_state_derivative!
+FLOWUnsteady.reset_dynamic_state_derivative!
+FLOWUnsteady.set_dynamic_state!
+FLOWUnsteady.set_position!
+FLOWUnsteady.set_orientation!
+FLOWUnsteady.quaternion_frame_2_top
+FLOWUnsteady.transform_parent_2_top
+FLOWUnsteady.apply_force!
+FLOWUnsteady.apply_moment!
+FLOWUnsteady.kinematic_velocity!
+```