Skip to content

Commit 1fcb3b6

Browse files
authored
Merge pull request #140 from SciML/fb/causal_ap
emphasize causality for analysis points
2 parents cd768c0 + f99f200 commit 1fcb3b6

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/src/API/linear_analysis.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@ An analysis point can be created explicitly using the constructor [`AnalysisPoin
1616
connect(comp1.output, :analysis_point_name, comp2.input)
1717
```
1818

19+
!!! warning "Causality"
20+
Analysis points are *causal*, i.e., they imply a directionality for the flow of information. The order of the connections in the connect statement is thus important, i.e., `connect(out, :name, in)` is different from `connect(in, :name, out)`.
21+
22+
The directionality of an analysis point can be thought of as an arrow in a block diagram, where the name of the analysis point applies to the arrow itself.
23+
```
24+
┌─────┐ ┌─────┐
25+
│ │ name │ │
26+
│ out├────────►│in │
27+
│ │ │ │
28+
└─────┘ └─────┘
29+
```
30+
This is signified by the name being the middle argument to `connect`.
31+
1932
Of the above mentioned functions, all except for [`open_loop`](@ref) return the output of [`ModelingToolkit.linearize`](@ref), which is
2033
```julia
2134
matrices, simplified_sys = linearize(...)

0 commit comments

Comments
 (0)