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

Update comments for some DGSEM APIs #2238

Merged
merged 3 commits into from
Jan 17, 2025
Merged

Update comments for some DGSEM APIs #2238

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb27c28
Update
huiyuxie Jan 16, 2025
00ec2ac
Merge branch 'main' into dgsem
huiyuxie Jan 16, 2025
eb5f2ce
Add
huiyuxie Jan 17, 2025
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: 4 additions & 3 deletions src/solvers/dgsem/dgsem.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Create a discontinuous Galerkin spectral element method (DGSEM) using a
"""
const DGSEM = DG{Basis} where {Basis <: LobattoLegendreBasis}

# TODO: Deprecated in v0.3 (no longer documented)
# This API is no longer documented, and we recommend avoiding its public use.
function DGSEM(basis::LobattoLegendreBasis,
surface_flux = flux_central,
volume_integral = VolumeIntegralWeakForm(),
Expand All @@ -32,7 +32,7 @@ function DGSEM(basis::LobattoLegendreBasis,
typeof(volume_integral)}(basis, mortar, surface_integral, volume_integral)
end

# TODO: Deprecated in v0.3 (no longer documented)
# This API is no longer documented, and we recommend avoiding its public use.
function DGSEM(basis::LobattoLegendreBasis,
surface_integral::AbstractSurfaceIntegral,
volume_integral = VolumeIntegralWeakForm(),
Expand All @@ -41,7 +41,7 @@ function DGSEM(basis::LobattoLegendreBasis,
typeof(volume_integral)}(basis, mortar, surface_integral, volume_integral)
end

# TODO: Deprecated in v0.3 (no longer documented)
# This API is no longer documented, and we recommend avoiding its public use.
function DGSEM(RealT, polydeg::Integer,
surface_flux = flux_central,
volume_integral = VolumeIntegralWeakForm(),
Expand All @@ -51,6 +51,7 @@ function DGSEM(RealT, polydeg::Integer,
return DGSEM(basis, surface_flux, volume_integral, mortar)
end

# This API is no longer documented, and we recommend avoiding its public use.
function DGSEM(polydeg, surface_flux = flux_central,
volume_integral = VolumeIntegralWeakForm())
DGSEM(Float64, polydeg, surface_flux, volume_integral)
Expand Down
Loading