Skip to content

Commit e398b49

Browse files
authored
mark linear analysis interface as experimental
1 parent 27887ac commit e398b49

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/src/API/linear_analysis.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Linear Analysis
22

3+
!!! danger "Experimental"
4+
The interface described here is currently experimental and at any time subject to breaking changes not respecting semantic versioning.
5+
36
Linear analysis refers to the process of linearizing a nonlinear model and analysing the resulting linear dynamical system. To facilitate linear analysis, ModelingToolkitStandardLibrary provides the concept of an [`AnalysisPoint`](@ref), which can be inserted inbetween two causal blocks (such as those from the Blocks sub module). Once a model containing analysis points is built, several operations are available:
47

58
- [`get_sensitivity`](@ref) get the [sensitivity function (wiki)](https://en.wikipedia.org/wiki/Sensitivity_(control_systems)), $S(s)$, as defined in the field of control theory.
@@ -94,4 +97,4 @@ Modules = [ModelingToolkitStandardLibrary.Blocks]
9497
Pages = ["Blocks/analysis_points.jl"]
9598
Order = [:function, :type]
9699
Private = false
97-
```
100+
```

0 commit comments

Comments
 (0)