diff --git a/.typos.toml b/.typos.toml index cabb966b..2166a37a 100644 --- a/.typos.toml +++ b/.typos.toml @@ -1,4 +1,6 @@ [default.extend-words] +# Math subscript in LaTeX (m_{iy} = y-component of midpoint m_i) in docs/src/math.md +iy = "iy" # Julia-specific functions indexin = "indexin" findfirst = "findfirst" diff --git a/docs/make.jl b/docs/make.jl index 9883cc17..4aa85338 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -28,7 +28,7 @@ if RUN_EXAMPLES ) return content end - # We can add the code to the end of each file in its uncommented form programatically. + # We can add the code to the end of each file in its uncommented form programmatically. function add_just_the_code_section(dir, file) file_name, file_ext = splitext(file) file_path = joinpath(dir, file) diff --git a/docs/src/literate_tutorials/laplaces_equation_with_internal_dirichlet_conditions.jl b/docs/src/literate_tutorials/laplaces_equation_with_internal_dirichlet_conditions.jl index be12bd0a..9c161b38 100644 --- a/docs/src/literate_tutorials/laplaces_equation_with_internal_dirichlet_conditions.jl +++ b/docs/src/literate_tutorials/laplaces_equation_with_internal_dirichlet_conditions.jl @@ -59,7 +59,7 @@ BCs = BoundaryConditions(mesh, bcs, types) # This is done using `InternalConditions`. First, # we need to find all the vertices that lie on # the line $\{x = 1/2, 0 \leq y \leq 2/5\}$. We could -# compute these manually, but let's find them programatically +# compute these manually, but let's find them programmatically # instead for the sake of demonstration. function find_all_points_on_line(tri) vertices = Int[] diff --git a/docs/src/literate_tutorials/piecewise_linear_and_natural_neighbour_interpolation_for_an_advection_diffusion_equation.jl b/docs/src/literate_tutorials/piecewise_linear_and_natural_neighbour_interpolation_for_an_advection_diffusion_equation.jl index b96426eb..10516745 100644 --- a/docs/src/literate_tutorials/piecewise_linear_and_natural_neighbour_interpolation_for_an_advection_diffusion_equation.jl +++ b/docs/src/literate_tutorials/piecewise_linear_and_natural_neighbour_interpolation_for_an_advection_diffusion_equation.jl @@ -1,6 +1,6 @@ using DisplayAs #hide tc = DisplayAs.withcontext(:displaysize => (15, 80), :limit => true); #hide -# # Piecewise Linear and Natural Neighbour Inteprolation for an Advection-Diffusion Equation +# # Piecewise Linear and Natural Neighbour Interpolation for an Advection-Diffusion Equation # In this tutorial, we have three aims: # # 1. Demonstrate how to solve an advection-diffusion equation. @@ -243,7 +243,7 @@ fig ) fig #src # ## Natural neighbour interpolation -# Since the solution is defined over a triangulation, the most natural form of inteprolation to use, +# Since the solution is defined over a triangulation, the most natural form of interpolation to use, # other than piecewise linear interpolation, is natural neighbour interpolation. We can use # [NaturalNeighbours.jl](https://github.com/DanielVandH/NaturalNeighbours.jl) for this; # NaturalNeighbours.jl also provides the same piecewise linear interpolant above via its diff --git a/docs/src/literate_tutorials/porous_fisher_equation_and_travelling_waves.jl b/docs/src/literate_tutorials/porous_fisher_equation_and_travelling_waves.jl index dfdb71dd..86960058 100644 --- a/docs/src/literate_tutorials/porous_fisher_equation_and_travelling_waves.jl +++ b/docs/src/literate_tutorials/porous_fisher_equation_and_travelling_waves.jl @@ -38,7 +38,7 @@ tc = DisplayAs.withcontext(:displaysize => (15, 80), :limit => true); #hide # \end{equation} # ``` # where $c_{\min} = \sqrt{\lambda/(2D)}$, $c = \sqrt{D\lambda/2}$, and $z = x-ct$ is the -# travelling wave coordinates. This travelling wave would mathc our problem exactly +# travelling wave coordinates. This travelling wave would match our problem exactly # if the rectangle were instead $[0, a] \times \mathbb R$, but by choosing $b$ large # enough we can at least emulate the travelling wave behaviour closely; the # homogeneous Neumann conditions are to ensure no energy is lost, thus allowing the travelling diff --git a/docs/src/literate_wyos/diffusion_equations.jl b/docs/src/literate_wyos/diffusion_equations.jl index 77e6f1fa..e607e3e3 100644 --- a/docs/src/literate_wyos/diffusion_equations.jl +++ b/docs/src/literate_wyos/diffusion_equations.jl @@ -176,7 +176,7 @@ function boundary_edge_contributions!( end # Now that we have the parts for handling the main flux contributions, we need to consider -# the boundary conditions. Note that in the code above we have alredy taken not to update +# the boundary conditions. Note that in the code above we have already taken not to update # $\vb A$ or $\vb b$ if there a boundary condition at the associated node, so we do not # need to worry about e.g. zeroing out rows of $\vb A$ for a node with a boundary condition. function apply_dirichlet_conditions!(initial_condition, mesh, conditions) diff --git a/docs/src/literate_wyos/linear_reaction_diffusion_equations.jl b/docs/src/literate_wyos/linear_reaction_diffusion_equations.jl index 87762b98..92e0f5fa 100644 --- a/docs/src/literate_wyos/linear_reaction_diffusion_equations.jl +++ b/docs/src/literate_wyos/linear_reaction_diffusion_equations.jl @@ -14,7 +14,7 @@ tc = DisplayAs.withcontext(:displaysize => (15, 80), :limit => true); #hide # ``` # We want to turn this into an equation of the form $\mathrm d\vb u/\mathrm dt = \vb A\vb u + \vb b$ # as usual. This takes the same form as our [diffusion equation example](diffusion_equations.md), -# except with the extra $f(\vb x)u$ term, which just adds an exta $f(\vb x)$ term +# except with the extra $f(\vb x)u$ term, which just adds an extra $f(\vb x)$ term # to the diagonal of $\vb A$. See the previois sections for further mathematical details. # ## Implementation diff --git a/docs/src/literate_wyos/poissons_equation.jl b/docs/src/literate_wyos/poissons_equation.jl index 75a0fcd6..ed3c5dcd 100644 --- a/docs/src/literate_wyos/poissons_equation.jl +++ b/docs/src/literate_wyos/poissons_equation.jl @@ -312,7 +312,7 @@ E |> tc #hide # For plotting the electric field, we will show the electric field intensity $\|\vb E\|$, # and we can also show the arrows. Rather than showing all arrows, we will show them at # a smaller grid of values, which requires differentiating `itp` so that we can get the -# gradients at arbitary points. +# gradients at arbitrary points. ∂ = differentiate(itp, 1) x = LinRange(0, 10, 25) y = LinRange(0, 10, 25) diff --git a/docs/src/tutorials/laplaces_equation_with_internal_dirichlet_conditions.md b/docs/src/tutorials/laplaces_equation_with_internal_dirichlet_conditions.md index 48d84ffc..fb82daec 100644 --- a/docs/src/tutorials/laplaces_equation_with_internal_dirichlet_conditions.md +++ b/docs/src/tutorials/laplaces_equation_with_internal_dirichlet_conditions.md @@ -82,7 +82,7 @@ We now need to define the internal conditions. This is done using `InternalConditions`. First, we need to find all the vertices that lie on the line $\{x = 1/2, 0 \leq y \leq 2/5\}$. We could -compute these manually, but let's find them programatically +compute these manually, but let's find them programmatically instead for the sake of demonstration. ````@example laplaces_equation_with_internal_dirichlet_conditions diff --git a/docs/src/tutorials/piecewise_linear_and_natural_neighbour_interpolation_for_an_advection_diffusion_equation.md b/docs/src/tutorials/piecewise_linear_and_natural_neighbour_interpolation_for_an_advection_diffusion_equation.md index 9eb2a4ac..ae39a594 100644 --- a/docs/src/tutorials/piecewise_linear_and_natural_neighbour_interpolation_for_an_advection_diffusion_equation.md +++ b/docs/src/tutorials/piecewise_linear_and_natural_neighbour_interpolation_for_an_advection_diffusion_equation.md @@ -8,7 +8,7 @@ tc = DisplayAs.withcontext(:displaysize => (15, 80), :limit => true); #hide nothing #hide ```` -# Piecewise Linear and Natural Neighbour Inteprolation for an Advection-Diffusion Equation +# Piecewise Linear and Natural Neighbour Interpolation for an Advection-Diffusion Equation In this tutorial, we have three aims: @@ -210,7 +210,7 @@ fig ## Natural neighbour interpolation -Since the solution is defined over a triangulation, the most natural form of inteprolation to use, +Since the solution is defined over a triangulation, the most natural form of interpolation to use, other than piecewise linear interpolation, is natural neighbour interpolation. We can use [NaturalNeighbours.jl](https://github.com/DanielVandH/NaturalNeighbours.jl) for this; NaturalNeighbours.jl also provides the same piecewise linear interpolant above via its diff --git a/docs/src/tutorials/porous_fisher_equation_and_travelling_waves.md b/docs/src/tutorials/porous_fisher_equation_and_travelling_waves.md index 05dfb0e5..9079dd88 100644 --- a/docs/src/tutorials/porous_fisher_equation_and_travelling_waves.md +++ b/docs/src/tutorials/porous_fisher_equation_and_travelling_waves.md @@ -53,7 +53,7 @@ u(y, t) = \begin{cases} 1-\mathrm{e}^{c_{\min}z} & z \leq 0, \\ 0 & z > 0, \end{ ``` where $c_{\min} = \sqrt{\lambda/(2D)}$, $c = \sqrt{D\lambda/2}$, and $z = x-ct$ is the -travelling wave coordinates. This travelling wave would mathc our problem exactly +travelling wave coordinates. This travelling wave would match our problem exactly if the rectangle were instead $[0, a] \times \mathbb R$, but by choosing $b$ large enough we can at least emulate the travelling wave behaviour closely; the homogeneous Neumann conditions are to ensure no energy is lost, thus allowing the travelling diff --git a/docs/src/wyos/diffusion_equations.md b/docs/src/wyos/diffusion_equations.md index d2971638..6308c679 100644 --- a/docs/src/wyos/diffusion_equations.md +++ b/docs/src/wyos/diffusion_equations.md @@ -198,7 +198,7 @@ end ```` Now that we have the parts for handling the main flux contributions, we need to consider -the boundary conditions. Note that in the code above we have alredy taken not to update +the boundary conditions. Note that in the code above we have already taken not to update $\vb A$ or $\vb b$ if there a boundary condition at the associated node, so we do not need to worry about e.g. zeroing out rows of $\vb A$ for a node with a boundary condition. diff --git a/docs/src/wyos/linear_reaction_diffusion_equations.md b/docs/src/wyos/linear_reaction_diffusion_equations.md index 3cd6bc32..38ec02e1 100644 --- a/docs/src/wyos/linear_reaction_diffusion_equations.md +++ b/docs/src/wyos/linear_reaction_diffusion_equations.md @@ -27,7 +27,7 @@ To start, let's give the mathematical details. The problems we will be solving t We want to turn this into an equation of the form $\mathrm d\vb u/\mathrm dt = \vb A\vb u + \vb b$ as usual. This takes the same form as our [diffusion equation example](diffusion_equations.md), -except with the extra $f(\vb x)u$ term, which just adds an exta $f(\vb x)$ term +except with the extra $f(\vb x)u$ term, which just adds an extra $f(\vb x)$ term to the diagonal of $\vb A$. See the previois sections for further mathematical details. ## Implementation diff --git a/docs/src/wyos/poissons_equation.md b/docs/src/wyos/poissons_equation.md index 453867be..24e75c16 100644 --- a/docs/src/wyos/poissons_equation.md +++ b/docs/src/wyos/poissons_equation.md @@ -356,7 +356,7 @@ E |> tc #hide For plotting the electric field, we will show the electric field intensity $\|\vb E\|$, and we can also show the arrows. Rather than showing all arrows, we will show them at a smaller grid of values, which requires differentiating `itp` so that we can get the -gradients at arbitary points. +gradients at arbitrary points. ````@example poissons_equation ∂ = differentiate(itp, 1) diff --git a/src/specific_problems/mean_exit_time.jl b/src/specific_problems/mean_exit_time.jl index 2387a3a6..2d3bd471 100644 --- a/src/specific_problems/mean_exit_time.jl +++ b/src/specific_problems/mean_exit_time.jl @@ -26,7 +26,7 @@ You can solve this problem using [`solve`](@ref solve(::AbstractFVMTemplate, arg - `ICs::InternalConditions=InternalConditions()`: The [`InternalConditions`](@ref). The functions for `BCs` and `ICs` are not used. Whenever a [`Neumann`](@ref) condition is encountered, -or a [`Dirichlet`](@ref) condition, it is assumed that the conditon is homogeneous. If any of the +or a [`Dirichlet`](@ref) condition, it is assumed that the condition is homogeneous. If any of the conditions are [`Dudt`](@ref) or [`Constrained`](@ref) types, then an error is thrown. ## Keyword Arguments