Skip to content

Commit

Permalink
correct docs, update to julia 1.8 for docs (documentation.yml)
Browse files Browse the repository at this point in the history
  • Loading branch information
rveltz committed May 8, 2023
1 parent efe46ea commit a31f2dc
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 43 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: '1.6'
version: '1.8'
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
Expand Down
42 changes: 0 additions & 42 deletions docs/src/branchswitching.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,7 @@ An example of use is provided in [2d generalized Bratu–Gelfand problem](@ref).

In order to compute the bifurcated branch of periodic solutions at a Hopf bifurcation point, you need to choose a method to compute periodic orbits among:

- [Periodic orbits based on Trapezoidal rule](@ref)
- [Periodic orbits based on orthogonal collocation](@ref)
- [Periodic orbits based on the shooting method](@ref)

Once you have decided which method to use, you use the following call:

Expand All @@ -77,44 +75,4 @@ continuation(br::ContResult, ind_HOPF::Int, _contParams::ContinuationPar,

We refer to [`continuation`](@ref) for more information about the arguments. Here, we just say a few words about how we can specify `prob::AbstractPeriodicOrbitProblem`.

- For [Periodic orbits based on Trapezoidal rule](@ref), you can pass `PeriodicOrbitTrapProblem(M = 51)` where `M` is the number of times slices in the periodic orbit.

- For [Periodic orbits based on orthogonal collocation](@ref), you can pass `PeriodicOrbitOCollProblem(M, m)` where `M` is the number of times slices in the periodic orbit and `m` is the degree of the collocation polynomials.

- For [Periodic orbits based on the shooting method](@ref), you need more parameters. For example, you can pass `ShootingProblem(M, odeprob, Euler())` or `PoincareShootingProblem(M, odeprob, Euler())` where `odeprob::ODEProblem` (see [`DifferentialEquations.jl`](https://diffeq.sciml.ai/stable/types/ode_types/)) is an ODE problem to specify the Cauchy problem amd `M` is the number of sections.

Several examples are provided in [1d Brusselator (automatic)](@ref) or [2d Ginzburg-Landau equation (finite differences, codim 2, Hopf aBS)](@ref).

> See [Branch switching (Hopf point)](@ref) for the precise method definition
## Branch switching from Branch / Period-doubling point of curve of periodic orbits

We do not provide (for now) the associated normal forms to these bifurcations of periodic orbits. As a consequence, the user is asked to provide the amplitude of the bifurcated solution.

We provide the branching method for the following methods to compute periodic orbits: [`PeriodicOrbitTrapProblem`](@ref),[`ShootingProblem`](@ref) and [`PoincareShootingProblem`](@ref). The call is as follows. Please note that a deflation is included in this method to simplify branch switching.

An example of use is provided in [Period doubling in Lur'e problem (PD aBS)](@ref).

```julia
continuation(br::AbstractBranchResult, ind_PD::Int, contParams::ContinuationPar;
δp = 0.1, ampfactor = 1, usedeflation = false, kwargs...)
```

## Branch switching from Bogdanov-Takens (BT) point to Fold / Hopf curve

We provide an automatic branch switching method in this case (see for example [Extended Lorenz-84 model (codim 2 + BT/ZH aBS)](@ref) or [2d Ginzburg-Landau equation (finite differences, codim 2, Hopf aBS)](@ref)). Hence, you can perform automatic branch switching by calling `continuation` with the following options:

```julia
continuation(br::ContResult, ind_BT::Int,
options_cont::ContinuationPar = br.contparams;
δp = nothing, ampfactor::Real = 1,
nev = options_cont.nev,
detectCodim2Bifurcation::Int = 0,
startWithEigen = false,
autodiff = false,
Teigvec = getvectortype(br),
scaleζ = norm,
kwargs...)
```

where `ind_BT` is the index of the BT point in `br`. Note that the BT has been detected during Fold or Hopf continuation. Calling the above method thus switches from Fold continuation to Hopf continuation (and vice-versa) automatically with the same parameter axis.

0 comments on commit a31f2dc

Please sign in to comment.