Skip to content

Commit 1d7ddff

Browse files
YingboMaChrisRackauckas
authored andcommitted
Document getters
1 parent ae029d0 commit 1d7ddff

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

docs/src/systems/AbstractSystem.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,20 @@ total set, which includes that of all systems held inside.
1717

1818
The values which are common to all `AbstractSystem`s are:
1919

20-
- `sys.eqs` or `equations(sys)`: The equations that define the system.
21-
- `sys.states` or `states(sys)`: The set of states in the system.
22-
- `sys.parameters` or `parameters(sys)`: The parameters of the system.
23-
- `sys.systems`: The subsystems of the system.
20+
- `equations(sys)`: All equations that define the system and its subsystems.
21+
- `states(sys)`: All the states in the system and its subsystems.
22+
- `parameters(sys)`: All parameters of the system and its subsystems.
23+
- `get_equations(sys)`: Equations that define the current-level system.
24+
- `get_states(sys)`: States that are in the current-level system.
25+
- `get_ps(sys)`: Parameters that are in the current-level system.
26+
- `get_systems(sys)`: Subsystems of the current-level system.
27+
- `get_name(sys)` or `nameof(sys)`: The name of the current-level system.
28+
29+
Optionally, a system could have
30+
31+
- `get_default_u0`: A `Dict` that maps states into their default initial
32+
condition.
33+
- `get_default_p`: A `Dict` that maps parameters into their default value.
2434

2535
## Transformations
2636

0 commit comments

Comments
 (0)