Skip to content

Commit e083c31

Browse files
Add a note in the docstrings
1 parent 7980f91 commit e083c31

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

src/time_evolution/smesolve.jl

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,9 @@ Above, ``\hat{C}_i`` represent the collapse operators related to pure dissipatio
6565
- The default tolerances in `kwargs` are given as `reltol=1e-2` and `abstol=1e-2`.
6666
- For more details about `kwargs` please refer to [`DifferentialEquations.jl` (Keyword Arguments)](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/)
6767
68+
!!! tip "Performance Tip"
69+
When `sc_ops` contains only one operator, it is highly recommended to put only the operator as the argument. This will ensure the stochastic noise to be diagonal, allowing for a faster simulation.
70+
6871
# Returns
6972
7073
- `prob`: The [`TimeEvolutionProblem`](@ref) containing the `SDEProblem` for the Stochastic Master Equation time evolution.
@@ -207,6 +210,9 @@ Above, ``\hat{C}_i`` represent the collapse operators related to pure dissipatio
207210
- The default tolerances in `kwargs` are given as `reltol=1e-2` and `abstol=1e-2`.
208211
- For more details about `kwargs` please refer to [`DifferentialEquations.jl` (Keyword Arguments)](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/)
209212
213+
!!! tip "Performance Tip"
214+
When `sc_ops` contains only one operator, it is highly recommended to put only the operator as the argument. This will ensure the stochastic noise to be diagonal, allowing for a faster simulation.
215+
210216
# Returns
211217
212218
- `prob`: The [`TimeEvolutionProblem`](@ref) containing the Ensemble `SDEProblem` for the Stochastic Master Equation time evolution.
@@ -332,6 +338,9 @@ Above, ``\hat{C}_i`` represent the collapse operators related to pure dissipatio
332338
- The default tolerances in `kwargs` are given as `reltol=1e-2` and `abstol=1e-2`.
333339
- For more details about `kwargs` please refer to [`DifferentialEquations.jl` (Keyword Arguments)](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/)
334340
341+
!!! tip "Performance Tip"
342+
When `sc_ops` contains only one operator, it is highly recommended to put only the operator as the argument. This will ensure the stochastic noise to be diagonal, allowing for a faster simulation.
343+
335344
# Returns
336345
337346
- `sol::TimeEvolutionStochasticSol`: The solution of the time evolution. See [`TimeEvolutionStochasticSol`](@ref).

src/time_evolution/ssesolve.jl

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ Above, ``\hat{S}_n`` are the stochastic collapse operators and ``dW_n(t)`` is th
6767
- The default tolerances in `kwargs` are given as `reltol=1e-2` and `abstol=1e-2`.
6868
- For more details about `kwargs` please refer to [`DifferentialEquations.jl` (Keyword Arguments)](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/)
6969
70+
!!! tip "Performance Tip"
71+
When `sc_ops` contains only one operator, it is highly recommended to put only the operator as the argument. This will ensure the stochastic noise to be diagonal, allowing for a faster simulation.
72+
7073
# Returns
7174
7275
- `prob`: The `SDEProblem` for the Stochastic Schrödinger time evolution of the system.
@@ -207,6 +210,9 @@ Above, ``\hat{S}_n`` are the stochastic collapse operators and ``dW_n(t)`` is t
207210
- The default tolerances in `kwargs` are given as `reltol=1e-2` and `abstol=1e-2`.
208211
- For more details about `kwargs` please refer to [`DifferentialEquations.jl` (Keyword Arguments)](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/)
209212
213+
!!! tip "Performance Tip"
214+
When `sc_ops` contains only one operator, it is highly recommended to put only the operator as the argument. This will ensure the stochastic noise to be diagonal, allowing for a faster simulation.
215+
210216
# Returns
211217
212218
- `prob::EnsembleProblem with SDEProblem`: The Ensemble SDEProblem for the Stochastic Shrödinger time evolution.
@@ -333,6 +339,9 @@ Above, ``\hat{S}_n`` are the stochastic collapse operators and ``dW_n(t)`` is th
333339
- For more details about `alg` please refer to [`DifferentialEquations.jl` (SDE Solvers)](https://docs.sciml.ai/DiffEqDocs/stable/solvers/sde_solve/)
334340
- For more details about `kwargs` please refer to [`DifferentialEquations.jl` (Keyword Arguments)](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/)
335341
342+
!!! tip "Performance Tip"
343+
When `sc_ops` contains only one operator, it is highly recommended to put only the operator as the argument. This will ensure the stochastic noise to be diagonal, allowing for a faster simulation.
344+
336345
# Returns
337346
338347
- `sol::TimeEvolutionStochasticSol`: The solution of the time evolution. See [`TimeEvolutionStochasticSol`](@ref).

0 commit comments

Comments
 (0)