|
91 | 91 |
|
92 | 92 | ### Connect |
93 | 93 | abstract type AbstractConnectType end |
| 94 | +""" |
| 95 | + $(TYPEDEF) |
| 96 | +
|
| 97 | +Flag which is meant to be passed to the `connect` metadata of a variable to affect how it |
| 98 | +behaves when the connector it is in is part of a `connect` equation. `Equality` is the |
| 99 | +default value and such variables when connected are made equal. For example, electric |
| 100 | +potential is equated at a junction. |
| 101 | +
|
| 102 | +For more information, refer to the [Connection semantics](@ref connect_semantics) section |
| 103 | +of the docs. |
| 104 | +
|
| 105 | +See also: [`Symbolics.connect`](@ref), [`@connector`](@ref), [`Flow`](@ref), |
| 106 | +[`Stream`](@ref). |
| 107 | +""" |
94 | 108 | struct Equality <: AbstractConnectType end # Equality connection |
| 109 | +""" |
| 110 | + $(TYPEDEF) |
| 111 | +
|
| 112 | +Flag which is meant to be passed to the `connect` metadata of a variable to affect how it |
| 113 | +behaves when the connector it is in is part of a `connect` equation. `Flow` denotes that |
| 114 | +the sum of marked variable in all connectors in the connection set must sum to zero. For |
| 115 | +example, electric current sums to zero at a junction (assuming appropriate signs are used |
| 116 | +for current flowing in and out of the function). |
| 117 | +
|
| 118 | +For more information, refer to the [Connection semantics](@ref connect_semantics) section |
| 119 | +of the docs. |
| 120 | +
|
| 121 | +See also: [`Symbolics.connect`](@ref), [`@connector`](@ref), [`Equality`](@ref), |
| 122 | +[`Stream`](@ref). |
| 123 | +""" |
95 | 124 | struct Flow <: AbstractConnectType end # sum to 0 |
| 125 | +""" |
| 126 | + $(TYPEDEF) |
| 127 | +
|
| 128 | +Flag which is meant to be passed to the `connect` metadata of a variable to affect how it |
| 129 | +behaves when the connector it is in is part of a `connect` equation. `Stream` denotes that |
| 130 | +the variable is part of a special stream connector. |
| 131 | +
|
| 132 | +For more information, refer to the [Connection semantics](@ref connect_semantics) section |
| 133 | +of the docs. |
| 134 | +
|
| 135 | +See also: [`Symbolics.connect`](@ref), [`@connector`](@ref), [`Equality`](@ref), |
| 136 | +[`Flow`](@ref). |
| 137 | +""" |
96 | 138 | struct Stream <: AbstractConnectType end # special stream connector |
97 | 139 |
|
98 | 140 | """ |
|
0 commit comments