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

Jump to bottom

DAE initialization note #604

Merged
merged 6 commits into from
Feb 28, 2023
Merged

DAE initialization note #604

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
aa17e78
Rename file.
Feb 24, 2023
f7318c5
Trying to explainthat DAE initialization can be quite problematic.
Feb 24, 2023
4aa837a
Try to condense the information and kick out the example.
Feb 24, 2023
09a2c79
Move DAE initialization link above note.
Feb 24, 2023
c4c5d60
Update docs/src/manual/initial_and_boundary_conditions.md
termi-official Feb 26, 2023
cc1a162
Apply suggestions from code review
fredrikekre Feb 28, 2023
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
4 changes: 2 additions & 2 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ GENERATEDEXAMPLES = [joinpath("examples", f) for f in (
"Manual" => [
"manual/degrees_of_freedom.md",
"manual/assembly.md",
"manual/boundary_conditions.md",
"manual/initial_and_boundary_conditions.md",
fredrikekre marked this conversation as resolved.
Show resolved Hide resolved
"manual/constraints.md",
"manual/grid.md",
"manual/export.md"
Expand All @@ -64,7 +64,7 @@ GENERATEDEXAMPLES = [joinpath("examples", f) for f in (
"reference/fevalues.md",
"reference/dofhandler.md",
"reference/assembly.md",
"reference/boundary_conditions.md",
"reference/initial_and_boundary_conditions.md",
fredrikekre marked this conversation as resolved.
Show resolved Hide resolved
"reference/grid.md",
"reference/export.md",
"reference/utils.md",
Expand Down
10 changes: 8 additions & 2 deletions docs/src/manual/boundary_conditions.md → ...manual/initial_and_boundary_conditions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
DocTestSetup = :(using Ferrite)
```

# Boundary Conditions
# Initial and Boundary Conditions

Every PDE is accompanied with boundary conditions. There are different types of boundary
conditions, and they need to be handled in different ways. Below we discuss how to handle
Expand Down Expand Up @@ -256,7 +256,7 @@ pdbc = PeriodicDirichlet(
)
```

# Initial Conditions
## Initial Conditions

When solving time-dependent problems, initial conditions, different from zero, may be required.
For finite element formulations of ODE-type,
Expand All @@ -273,3 +273,9 @@ apply_analytical!(u, dh, :p, x -> ρ * g * x[2])
```

See also [Time Dependent Problems](@ref) for one example.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we put this above the note?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick question here, why would you move it above the note?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is easy to miss that reference when reading the docs, but if switched, the note is still hard to miss. And it follows (in my mind) more logically as DAEs are not discussed in that example.


!!! note "Consistency"
`apply_analytical!` does not enforce consistency of the applied solution with the system of
equations. Some problems, like for example differential-algebraic systems of equations (DAEs)
need extra care during initialization. We refer to the paper ["Consistent Initial Condition Calculation for Differential-Algebraic Systems" by Brown et al.](dx.doi.org/10.1137/S1064827595289996) for more details on this matter.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably you should use the full https URL instead, this gives:

┌ Warning: invalid local link: unresolved path in manual/boundary_conditions.md
│   link_url = "dx.doi.org/10.1137/S1064827595289996"
└ @ Documenter.HTMLWriter ~/.julia/packages/Documenter/ZRco4/src/html/HTMLWriter.jl:2195


2 changes: 1 addition & 1 deletion docs/src/reference/boundary_conditions.md → ...erence/initial_and_boundary_conditions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ DocTestSetup = :(using Ferrite)
# Boundary Conditions

```@index
Pages = ["boundary_conditions.md"]
Pages = ["initial_and_boundary_conditions.md"]
fredrikekre marked this conversation as resolved.
Show resolved Hide resolved
```

```@docs
Expand Down