Skip to content

docs: add missing docstrings for ThermalEmission + StreamRTResult #223

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

Open
cfranken wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing docstrings for ThermalEmission + StreamRTResult #223

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
7 changes: 7 additions & 0 deletions docs/src/pages/api/core_rt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ vSmartMOM.CoreRT.RTNumericalParameters
> `surface_source_contribute!` dispatchers) are documented on the
> [Source terms](../extending/sources.md#api-reference) page.

## Stream-Level RT Output

```@docs
vSmartMOM.CoreRT.StreamRTResult
vSmartMOM.CoreRT.rt_run_streams(::Any)
```

## Jacobian Parameter Layout

```@docs
Expand Down
5 changes: 5 additions & 0 deletions docs/src/pages/extending/sources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,9 @@ vSmartMOM.CoreRT.PreparedSolarBeam
vSmartMOM.CoreRT.BlackbodySource(::Real, ::AbstractVector{<:Real})
vSmartMOM.CoreRT.SurfaceSIF
vSmartMOM.CoreRT.PreparedSurfaceSIF
vSmartMOM.CoreRT.ThermalEmission
vSmartMOM.CoreRT.ThermalEmission(::AbstractVector{<:Real}, ::AbstractVector{<:Real})
vSmartMOM.CoreRT.PreparedThermalEmission
```

### AD-mode traits
Expand All @@ -232,4 +235,6 @@ vSmartMOM.CoreRT.prepare_source(::vSmartMOM.CoreRT.SurfaceSIF, ::Type{<:Abstract
vSmartMOM.CoreRT.prepare_sources(::vSmartMOM.CoreRT.NoSource, ::Type{<:AbstractFloat}, ::Integer, ::Integer, ::Any)
vSmartMOM.CoreRT.surface_source_contribute!(::vSmartMOM.CoreRT.PreparedSurfaceSIF, ::Union{vSmartMOM.CoreRT.LambertianSurfaceLegendre, vSmartMOM.CoreRT.LambertianSurfaceScalar, vSmartMOM.CoreRT.LambertianSurfaceSpline}, ::Any, ::Integer, ::Any, ::Any)
vSmartMOM.CoreRT.surface_source_contribute!(::vSmartMOM.CoreRT.NoSource, ::vSmartMOM.CoreRT.AbstractSurfaceType, ::Vararg{Any, 4})
vSmartMOM.CoreRT.prepare_source(::vSmartMOM.CoreRT.ThermalEmission, ::Type{<:AbstractFloat}, ::Integer, ::Integer, ::Any)
vSmartMOM.CoreRT.contribute!(::vSmartMOM.CoreRT.PreparedThermalEmission, ::Any, ::AbstractVector, ::AbstractVector, ::Integer, ::Integer, ::Any, ::Any, ::Any)
```
Loading