Skip to content

Commit

Permalink
format
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisRackauckas committed Sep 4, 2024
1 parent 3858b9b commit 38aca03
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
5 changes: 3 additions & 2 deletions docs/src/basics/solution.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,10 @@ Extra fields for solutions of specific problems are specified in the appropriate
problem definition page.

## Solution Function Stripping
By default solution objects store functions, making them difficult to serialize. Using the function

By default solution objects store functions, making them difficult to serialize. Using the function
`strip_solution(sol)`, a copy of the solution that does not contain any functions is created.

```@docs
SciMLBase.strip_solution
```
```
6 changes: 3 additions & 3 deletions docs/src/tutorials/advanced_ode_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ equations (PDEs). For example, we will use the stiff Brusselator partial
differential equation (BRUSS).

!!! note

This tutorial is for advanced users to dive into advanced features!
DifferentialEquations.jl automates most of this usage, so we recommend
users try `solve(prob)` with the automatic algorithm first!

## Definition of the Brusselator Equation

!!! note

Feel free to skip this section: it simply defines the example problem.

The Brusselator PDE is defined on a unit square periodic domain as follows:
Expand Down Expand Up @@ -208,7 +208,7 @@ information on linear solver choices, see the
valid [LinearSolve.jl](https://linearsolve.sciml.ai/dev/) solver.

!!! note

Switching to a Krylov linear solver will automatically change the ODE solver
into Jacobian-free mode, dramatically reducing the memory required. This can
be overridden by adding `concrete_jac=true` to the algorithm.
Expand Down
8 changes: 4 additions & 4 deletions docs/src/tutorials/faster_ode_example.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# [Code Optimization for Differential Equations](@id speed)

!!! note

See [this FAQ](@ref faq_performance)
for information on common pitfalls and how to improve performance.

Expand Down Expand Up @@ -95,7 +95,7 @@ When the in-place form is used, DifferentialEquations.jl takes a different
internal route that minimizes the internal allocations as well.

!!! note

Notice that nothing is returned. When in in-place form, the ODE solver ignores
the return. Instead, make sure that the original `du` array is mutated instead
of constructing a new array
Expand Down Expand Up @@ -370,7 +370,7 @@ In this tutorial, we will optimize the right-hand side definition of a PDE
semi-discretization.

!!! note

We highly recommend looking at the [Solving Large Stiff Equations](@ref stiff)
tutorial for details on customizing DifferentialEquations.jl for more
efficient large-scale stiff ODE solving. This section will only focus on the
Expand Down Expand Up @@ -690,7 +690,7 @@ algorithms. `CVODE_BDF` allows us to use a sparse Newton-Krylov solver by
setting `linear_solver = :GMRES`.

!!! note

The [Solving Large Stiff Equations](@ref stiff) tutorial goes through these
details. This is simply to give a taste of how much optimization opportunity
is left on the table!
Expand Down

0 comments on commit 38aca03

Please sign in to comment.