Skip to content

Commit 52fa95e

Browse files
authored
Consistent doc header formatting (#1175)
1 parent b03a6fe commit 52fa95e

11 files changed

Lines changed: 18 additions & 18 deletions

File tree

docs/src/devdocs/dofhandler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [Dof Handler](@id dofhandler-interpolations)
1+
# [Dof handler](@id dofhandler-interpolations)
22

33
## Type definitions
44

docs/src/literate-tutorials/dg_heat_equation.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
#
126126
# More details on DG formulations for elliptic problems can be found in [Cockburn:2002:unifiedanalysis](@cite).
127127
#-
128-
# ## Commented Program
128+
# ## Commented program
129129
#
130130
# Now we solve the problem in Ferrite. What follows is a program spliced with comments.
131131
#md # The full program, without comments, can be found in the next [section](@ref heat_equation-DG-plain-program).

docs/src/literate-tutorials/heat_equation.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
# where $\delta u$ is a test function, and where $\mathbb{U}$ and $\mathbb{T}$ are suitable
3636
# trial and test function sets, respectively.
3737
#-
38-
# ## Commented Program
38+
# ## Commented program
3939
#
4040
# Now we solve the problem in Ferrite. What follows is a program spliced with comments.
4141
#md # The full program, without comments, can be found in the next [section](@ref heat_equation-plain-program).
@@ -73,7 +73,7 @@ close!(dh);
7373
# !!! warning "Numbering of degrees of freedom"
7474
# A common assumption is that the numbering of degrees of freedom follows the global
7575
# numbering of the nodes in the grid. This is *NOT* the case in Ferrite. For more
76-
# details, see the [Ferrite numbering rules](@ref "Ordering-of-Dofs").
76+
# details, see the [Ferrite numbering rules](@ref "Ordering-of-dofs").
7777

7878
# Now that we have distributed all our dofs we can create our tangent matrix,
7979
# using `allocate_matrix`. This function returns a sparse matrix

docs/src/literate-tutorials/linear_elasticity.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ close!(dh);
153153
# !!! warning "Numbering of degrees of freedom"
154154
# A common assumption is that the numbering of degrees of freedom follows the global
155155
# numbering of the nodes in the grid. This is *NOT* the case in Ferrite. For more
156-
# details, see the [Ferrite numbering rules](@ref "Ordering-of-Dofs").
156+
# details, see the [Ferrite numbering rules](@ref "Ordering-of-dofs").
157157

158158
# ### Boundary conditions
159159
# We set Dirichlet boundary conditions by fixing the motion normal to the bottom and left

docs/src/literate-tutorials/ns_vs_diffeq.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ nothing #hide
6767
# $\nu \partial_{\textrm{n}} v - p n = 0$ to model outflow. With these boundary conditions we can choose the zero solution as a
6868
# feasible initial condition.
6969
#
70-
# ### Derivation of Semi-Discrete Weak Form
70+
# ### Derivation of semi-discrete weak form
7171
#
7272
# By multiplying test functions $\varphi$ and $\psi$ from a suitable test function space on the strong form,
7373
# followed by integrating over the domain and applying partial integration to the pressure and viscosity terms
@@ -183,7 +183,7 @@ gmsh.model.mesh.generate(dim)
183183
grid = togrid()
184184
Gmsh.finalize();
185185

186-
# ### Function Space
186+
# ### Function space
187187
# To ensure stability we utilize the Taylor-Hood element pair Q2-Q1.
188188
# We have to utilize the same quadrature rule for the pressure as for the velocity, because in the weak form the
189189
# linear pressure term is tested against a quadratic function.
@@ -239,7 +239,7 @@ add!(ch, inflow_bc);
239239
close!(ch)
240240
update!(ch, 0.0);
241241

242-
# ### Linear System Assembly
242+
# ### Linear system assembly
243243
# Next we describe how the block mass matrix and the Stokes matrix are assembled.
244244
#
245245
# For the block mass matrix $M$ we remember that only the first equation had a time derivative

docs/src/literate-tutorials/reactive_surface.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ nothing #hide
6969
# for the theory behind operator splitting and can only refer to the original papers for each method.
7070
#
7171
#-
72-
# ## Commented Program
72+
# ## Commented program
7373
#
7474
# Now we solve the problem in Ferrite. What follows is a program spliced with comments.
7575
#md # The full program, without comments, can be found in the next [section](@ref reactive_surface-plain-program).

docs/src/literate-tutorials/transient_heat_equation.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
# to a prescribed dof in the system matrix ($\mathbf{A} = Δt \mathbf{K} + \mathbf{M}$) and setting the value of the right-hand side vector to the value
5353
# of the Dirichlet condition. Thus, we only need to apply in every time step the Dirichlet condition to the right-hand side of the problem.
5454
#-
55-
# ## Commented Program
55+
# ## Commented program
5656
#
5757
# Now we solve the problem in Ferrite. What follows is a program spliced with comments.
5858
#md # The full program, without comments, can be found in the next [section](@ref heat_equation-plain-program).

docs/src/reference/dofhandler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
DocTestSetup = :(using Ferrite)
33
```
44

5-
# Degrees of Freedom
5+
# Degrees of freedom
66
Degrees of freedom (dofs) are distributed by the [`DofHandler`](@ref).
77
```@docs
88
DofHandler

docs/src/topics/degrees_of_freedom.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using Ferrite
33
```
44

5-
# Degrees of Freedom
5+
# Degrees of freedom
66

77
The distribution and numbering of degrees of freedom (dofs) are handled by the `DofHandler`.
88
The DofHandler will be used to query information about the dofs. For example we can obtain
@@ -40,7 +40,7 @@ dofs for the fields we added.
4040
close!(dh)
4141
```
4242

43-
## Ordering of Dofs
43+
## Ordering of dofs
4444

4545
!!! todo
4646
Describe dof ordering within elements (vertices -> edges -> faces ->

docs/src/topics/fe_intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ where $\mathbb{U}, \mathbb{T}$ are suitable function spaces with sufficiently re
6363
functions. Under very general assumptions it can be shown that the solution to the weak
6464
form is identical to the solution to the strong form.
6565

66-
## Finite Element approximation
66+
## Finite element approximation
6767

6868

6969
Using the finite element method to solve partial differential equations is usually
@@ -77,7 +77,7 @@ Next, we introduce the finite element approximation $u_\mathrm{h} \approx u$ as
7777
Sometimes, the dofs are called *weights* or *nodal values*. In Ferrite, the numbering of the dofs does not correspond
7878
to the node numbers in the grid. While such numbering is common in basic finite element codes,
7979
Ferrite supports different approximations of the finite element fields and the geometry, prohibiting
80-
such basic numbering. For more details, see the [Ferrite numbering rules](@ref "Ordering-of-Dofs").
80+
such basic numbering. For more details, see the [Ferrite numbering rules](@ref "Ordering-of-dofs").
8181

8282
Note that *shape functions* are sometimes referred to as *basis functions* or *trial functions*,
8383
and instead of $\phi_i$ they are sometimes denoted $N_i$. In this example we choose to approximate

0 commit comments

Comments
 (0)