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

fix StructuredMesh docstrings #2208

Merged
merged 2 commits into from
Dec 13, 2024
Merged

fix StructuredMesh docstrings #2208

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1554bd0
fix StructuredMesh docstrings
ranocha Dec 13, 2024
1da044c
Apply suggestions from code review
ranocha Dec 13, 2024
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
23 changes: 15 additions & 8 deletions src/meshes/structured_mesh.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ end

"""
StructuredMesh(cells_per_dimension, mapping;
RealT=Float64,
unsaved_changes=true,
mapping_as_string=mapping2string(mapping, length(cells_per_dimension), RealT=RealT))
RealT = Float64,
periodicity = true,
unsaved_changes = true,
mapping_as_string = mapping2string(mapping, length(cells_per_dimension), RealT=RealT))

Create a StructuredMesh of the given size and shape that uses `RealT` as coordinate type.

Expand All @@ -46,8 +47,10 @@ Create a StructuredMesh of the given size and shape that uses `RealT` as coordin
The code string must define the mapping function with the name `mapping`.
This will be changed in the future, see [https://github.com/trixi-framework/Trixi.jl/issues/541](https://github.com/trixi-framework/Trixi.jl/issues/541).
"""
function StructuredMesh(cells_per_dimension, mapping; RealT = Float64,
periodicity = true, unsaved_changes = true,
function StructuredMesh(cells_per_dimension, mapping;
ranocha marked this conversation as resolved.
Show resolved Hide resolved
RealT = Float64,
periodicity = true,
ranocha marked this conversation as resolved.
Show resolved Hide resolved
unsaved_changes = true,
mapping_as_string = mapping2string(mapping,
length(cells_per_dimension),
RealT))
Expand All @@ -71,7 +74,9 @@ function StructuredMesh(cells_per_dimension, mapping; RealT = Float64,
end

"""
StructuredMesh(cells_per_dimension, faces; RealT=Float64, unsaved_changes=true, faces_as_string=faces2string(faces))
StructuredMesh(cells_per_dimension, faces;
RealT = Float64,
periodicity = true)

Create a StructuredMesh of the given size and shape that uses `RealT` as coordinate type.

Expand All @@ -89,7 +94,8 @@ Create a StructuredMesh of the given size and shape that uses `RealT` as coordin
- `periodicity`: either a `Bool` deciding if all of the boundaries are periodic or an `NTuple{NDIMS, Bool}` deciding for
each dimension if the boundaries in this dimension are periodic.
"""
function StructuredMesh(cells_per_dimension, faces::Tuple; RealT = Float64,
function StructuredMesh(cells_per_dimension, faces::Tuple;
RealT = Float64,
periodicity = true)
NDIMS = length(cells_per_dimension)

Expand Down Expand Up @@ -118,7 +124,8 @@ function StructuredMesh(cells_per_dimension, faces::Tuple; RealT = Float64,
end

"""
StructuredMesh(cells_per_dimension, coordinates_min, coordinates_max; periodicity=true)
StructuredMesh(cells_per_dimension, coordinates_min, coordinates_max;
periodicity = true)

Create a StructuredMesh that represents a uncurved structured mesh with a rectangular domain.

Expand Down
Loading