Merge pull request #103 from ytdHuang/dev/HEOMsolve

Introduce `HEOMsolve` and `TimeEvolutionHEOMSol`
qutip · Sep 15, 2024 · e386770 · e386770 · ytdHuang · Sep 15, 2024
2 parents 015f597 + cb272f5
commit e386770
Show file tree

Hide file tree

Showing 35 changed files with 731 additions and 835 deletions.
diff --git a/docs/src/ADOs.md b/docs/src/ADOs.md
@@ -16,7 +16,7 @@ In `HierarchicalEOM.jl`, we express all the auxiliary density operators into a s
 
 [`struct ADOs`](@ref ADOs), 
 
-which is usually obtained after solving the time [evolution](@ref doc-Time-Evolution) or [stationary state](@ref doc-Stationary-State) by a given [HEOM Liouvillian superoperator Matrix](@ref doc-HEOMLS-Matrix).
+which is usually obtained after solving the [time evolution](@ref doc-Time-Evolution) or [stationary state](@ref doc-Stationary-State) by a given [HEOM Liouvillian superoperator Matrix](@ref doc-HEOMLS-Matrix).
 
 ## Fields
 The fields of the structure [`ADOs`](@ref) are as follows:

diff --git a/docs/src/ODE_solvers.md b/docs/src/ODE_solvers.md
@@ -10,7 +10,7 @@ using OrdinaryDiffEq ## or "using DifferentialEquations"
 
 (click [here](https://docs.sciml.ai/DiffEqDocs/stable/solvers/ode_solve/) to see the full solver list provided by `DifferentialEquations.jl`)
 
-For any extra solver options, we can add it in the function `evolution` with keyword arguments. These keyword arguments will be directly pass to the solvers in `DifferentialEquations`
+For any extra solver options, we can add it in the function `HEOMsolve` with keyword arguments. These keyword arguments will be directly pass to the solvers in `DifferentialEquations`
 (click [here](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/) to see the documentation for the common solver options)
 
 ### DP5 (Default solver)

diff --git a/docs/src/extensions/CUDA.md b/docs/src/extensions/CUDA.md
@@ -69,18 +69,18 @@ ados_ss = steadystate(M_even_cpu);
 ```
 
 !!! note "Note"
-    This extension does not support for solving [stationary state](@ref doc-Stationary-State) on GPU since it is not efficient and might get wrong solutions. If you really want to obtain the stationary state with GPU, you can repeatedly solve the [`evolution`](@ref doc-Time-Evolution) until you find it.
+    This extension does not support for solving [stationary state](@ref doc-Stationary-State) on GPU since it is not efficient and might get wrong solutions. If you really want to obtain the stationary state with GPU, you can repeatedly solve the [time evolution](@ref doc-Time-Evolution) until you find it.
 
 ### Solving time evolution with CPU
 
 ```julia
-ados_list_cpu = evolution(M_even_cpu, ρ0, tlist)
+ados_list_cpu = HEOMsolve(M_even_cpu, ρ0, tlist)
 ```
 
 ### Solving time evolution with GPU
 
 ```julia
-ados_list_gpu = evolution(M_even_gpu, ρ0, tlist)
+ados_list_gpu = HEOMsolve(M_even_gpu, ρ0, tlist)
 ```
 
 ### Solving Spectrum with CPU

diff --git a/docs/src/heom_matrix/M_Boson.md b/docs/src/heom_matrix/M_Boson.md
@@ -38,7 +38,7 @@ The fields of the structure [`M_Boson`](@ref) are as follows:
  - `bath::Vector{BosonBath}` : the vector which stores all [`BosonBath`](@ref doc-Bosonic-Bath) objects
  - `hierarchy::HierarchyDict`: the object which contains all [dictionaries](@ref doc-Hierarchy-Dictionary) for boson-bath-ADOs hierarchy.
 
-One obtain the value of each fields as follows:
+One can obtain the value of each fields as follows:
 ```julia
 M::M_Boson
 

diff --git a/docs/src/heom_matrix/M_Boson_Fermion.md b/docs/src/heom_matrix/M_Boson_Fermion.md
@@ -44,7 +44,7 @@ The fields of the structure [`M_Boson_Fermion`](@ref) are as follows:
  - `Fbath::Vector{FermionBath}` : the vector which stores all [`FermionBath`](@ref doc-Fermionic-Bath) objects
  - `hierarchy::MixHierarchyDict`: the object which contains all [dictionaries](@ref doc-Hierarchy-Dictionary) for mixed-bath-ADOs hierarchy.
 
-One obtain the value of each fields as follows:
+One can obtain the value of each fields as follows:
 ```julia
 M::M_Boson_Fermion
 

diff --git a/docs/src/heom_matrix/M_Fermion.md b/docs/src/heom_matrix/M_Fermion.md
@@ -38,7 +38,7 @@ The fields of the structure [`M_Fermion`](@ref) are as follows:
  - `bath::Vector{FermionBath}` : the vector which stores all [`FermionBath`](@ref doc-Fermionic-Bath) objects
  - `hierarchy::HierarchyDict`: the object which contains all [dictionaries](@ref doc-Hierarchy-Dictionary) for fermion-bath-ADOs hierarchy.
 
-One obtain the value of each fields as follows:
+One can obtain the value of each fields as follows:
 ```julia
 M::M_Fermion
 

diff --git a/docs/src/heom_matrix/schrodinger_eq.md b/docs/src/heom_matrix/schrodinger_eq.md
@@ -36,7 +36,7 @@ The fields of the structure [`M_S`](@ref) are as follows:
  - `sup_dim` : the dimension of system superoperator
  - `parity::AbstractParity` : the [parity](@ref doc-Parity) label of the operator which HEOMLS is acting on.
 
-One obtain the value of each fields as follows:
+One can obtain the value of each fields as follows:
 ```julia
 M::M_S
 

diff --git a/docs/src/libraryAPI.md b/docs/src/libraryAPI.md
@@ -103,13 +103,14 @@ getIndexEnsemble
 ```
 
 ## [Time Evolution](@id lib-Time-Evolution)
-There are six function definitions of `evolution`, which depend on different input types and methods to solve the time evolution:
+There are two function definitions of `HEOMsolve`, which depend on different methods to solve the time evolution:
 ```@docs
-evolution
+HEOMsolve
+TimeEvolutionHEOMSol
 ```
 
 ## Stationary State
-There are three function definitions of `steadystate`, which depend on different input types and methods to solve the stationary state:
+There are two function definitions of `steadystate`, which depend on different methods to solve the stationary state:
 ```@docs
 steadystate
 ```