Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add temporary api docs with files #181

Merged
merged 1 commit into from
Jun 17, 2024
Merged

Add temporary api docs with files #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand All @@ -92,7 +94,7 @@ makedocs(
# "api/flowvpm-utils.md",
# ]
# ]
# ],
],
]
)

Expand Down
6 changes: 6 additions & 0 deletions docs/src/api/initializer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# initializer.jl

```@docs
FLOWUnsteady.AbstractInitializer
FLOWUnsteady.DefaultInitializer
```
4 changes: 4 additions & 0 deletions docs/src/api/integrator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# integrator.jl

```@docs
```
21 changes: 21 additions & 0 deletions docs/src/api/model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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!
```
8 changes: 8 additions & 0 deletions docs/src/api/postprocessing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# postprocessor.jl

```@docs
FLOWUnsteady.AbstractPostprocessor
FLOWUnsteady.History
FLOWUnsteady.ParaviewOutput
FLOWUnsteady.MultiPostprocessor
```
20 changes: 20 additions & 0 deletions docs/src/api/state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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!
```
Loading