Skip to content

Commit 5b2ec39

Browse files
committed
add has_step
1 parent 433ebff commit 5b2ec39

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

docs/src/interfaces/Algorithms.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ SciMLBase.isdiscrete
3636
SciMLBase.forwarddiffs_model
3737
SciMLBase.forwarddiffs_model_time
3838
SciMLBase.has_init
39+
SciMLBase.has_step
3940
```
4041

4142
### Abstract SciML Algorithms

src/SciMLBase.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -935,5 +935,6 @@ export ODEAliasSpecifier, LinearAliasSpecifier
935935
# Public traits
936936

937937
@public has_init
938+
@public has_step
938939

939940
end

src/alg_traits.jl

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,14 @@ supports_opt_cache_interface(alg) = false
308308
"""
309309
$(TYPEDSIGNATURES)
310310
311-
Trait for specifying whether the passed algorithm supports `init`.
311+
Trait for specifying whether the passed algorithm supports `init`. Any `init`ed object can `solve!`.
312312
"""
313313
has_init(a::AbstractSciMLAlgorithm) = false
314+
315+
"""
316+
$(TYPEDSIGNATURES)
317+
318+
Trait for specifying whether the passed algorithm supports `step!`, specifying a more direct control over the internal solver process.
319+
See https://docs.sciml.ai/SciMLBase/stable/interfaces/Init_Solve/#init-and-the-Iterator-Interface for more details.
320+
"""
321+
has_step(a::AbstractSciMLAlgorithm) = false

0 commit comments

Comments
 (0)