docs: split system accessors page

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>

Author: ChrisRackauckas

docs/pages.jl

@@ -38,6 +38,7 @@ pages = [
     "API" => Any[
         "API/modules.md",
         "API/System.md",
+        "API/System_accessors.md",
         "API/abstract_system_interface.md",
         "API/variables.md",
         "API/model_building.md",

docs/src/API/System.md

@@ -31,158 +31,6 @@ DiscreteSystem
 ImplicitDiscreteSystem
 ```
 
-## Accessor functions
-
-Several accessor functions exist to query systems for the information they contain. In general,
-for every field `x` there exists a `has_x` function which checks if the system contains the
-field and a `get_x` function for obtaining the value in the field. Note that fields of a system
-cannot be accessed via `getproperty` - that is reserved for accessing variables, subsystems
-or analysis points of the hierarchical system.
-
-```@docs
-ModelingToolkit.has_eqs
-ModelingToolkit.get_eqs
-equations
-ModelingToolkit.equations_toplevel
-full_equations
-ModelingToolkit.has_noise_eqs
-ModelingToolkit.get_noise_eqs
-ModelingToolkit.has_jumps
-ModelingToolkit.get_jumps
-jumps
-ModelingToolkit.has_constraints
-ModelingToolkit.get_constraints
-constraints
-ModelingToolkit.has_costs
-ModelingToolkit.get_costs
-cost
-ModelingToolkit.has_consolidate
-ModelingToolkit.get_consolidate
-ModelingToolkit.has_unknowns
-ModelingToolkit.get_unknowns
-unknowns
-ModelingToolkit.unknowns_toplevel
-ModelingToolkit.has_irreducibles
-ModelingToolkit.get_irreducibles
-irreducibles
-ModelingToolkit.has_maybe_zeros
-ModelingToolkit.get_maybe_zeros
-maybe_zeros
-ModelingToolkit.has_state_priorities
-ModelingToolkit.get_state_priorities
-state_priorities
-ModelingToolkit.has_ps
-ModelingToolkit.get_ps
-parameters
-ModelingToolkit.parameters_toplevel
-tunable_parameters
-bound_parameters
-ModelingToolkit.has_brownians
-ModelingToolkit.get_brownians
-brownians
-ModelingToolkit.has_poissonians
-ModelingToolkit.get_poissonians
-ModelingToolkit.has_iv
-ModelingToolkit.get_iv
-ModelingToolkitBase.independent_variable
-ModelingToolkitBase.independent_variables
-ModelingToolkit.has_ivs
-ModelingToolkit.get_ivs
-ModelingToolkit.has_dvs
-ModelingToolkit.get_dvs
-ModelingToolkit.has_tspan
-ModelingToolkit.get_tspan
-ModelingToolkit.has_observed
-ModelingToolkit.get_observed
-observed
-observables
-ModelingToolkit.has_name
-ModelingToolkit.get_name
-nameof
-ModelingToolkit.has_description
-ModelingToolkit.get_description
-ModelingToolkit.description
-ModelingToolkit.has_bindings
-ModelingToolkit.get_bindings
-bindings
-ModelingToolkit.has_initial_conditions
-ModelingToolkit.get_initial_conditions
-initial_conditions
-ModelingToolkit.has_guesses
-ModelingToolkit.get_guesses
-guesses
-ModelingToolkit.has_systems
-ModelingToolkit.get_systems
-ModelingToolkit.has_initialization_eqs
-ModelingToolkit.get_initialization_eqs
-initialization_equations
-ModelingToolkit.has_continuous_events
-ModelingToolkit.get_continuous_events
-continuous_events
-ModelingToolkit.continuous_events_toplevel
-ModelingToolkit.has_discrete_events
-ModelingToolkit.get_discrete_events
-discrete_events
-ModelingToolkit.discrete_events_toplevel
-ModelingToolkit.has_assertions
-ModelingToolkit.get_assertions
-ModelingToolkit.assertions
-ModelingToolkit.has_metadata
-ModelingToolkit.get_metadata
-SymbolicUtils.getmetadata(::ModelingToolkit.AbstractSystem, ::DataType, ::Any)
-SymbolicUtils.setmetadata(::ModelingToolkit.AbstractSystem, ::DataType, ::Any)
-ModelingToolkit.has_is_dde
-ModelingToolkit.get_is_dde
-ModelingToolkit.is_dde
-ModelingToolkit.has_tstops
-ModelingToolkit.get_tstops
-ModelingToolkit.symbolic_tstops
-ModelingToolkit.has_tearing_state
-ModelingToolkit.get_tearing_state
-ModelingToolkit.has_schedule
-ModelingToolkit.get_schedule
-ModelingToolkit.has_isscheduled
-ModelingToolkit.get_isscheduled
-ModelingToolkit.has_index_cache
-ModelingToolkit.get_index_cache
-ModelingToolkit.has_irstructure_tlv
-ModelingToolkit.get_irstructure_tlv
-ModelingToolkit.has_parameter_bindings_graph
-ModelingToolkit.get_parameter_bindings_graph
-ModelingToolkit.does_namespacing
-toggle_namespacing
-ModelingToolkit.iscomplete
-ModelingToolkit.has_preface
-ModelingToolkit.get_preface
-ModelingToolkit.preface
-ModelingToolkit.has_parent
-ModelingToolkit.get_parent
-ModelingToolkit.has_initializesystem
-ModelingToolkit.get_initializesystem
-ModelingToolkit.has_is_initializesystem
-ModelingToolkit.get_is_initializesystem
-ModelingToolkit.is_initializesystem
-ModelingToolkit.has_analytically_integrated
-ModelingToolkit.get_analytically_integrated
-analytically_integrated
-ModelingToolkit.has_connector_type
-ModelingToolkit.get_connector_type
-ModelingToolkit.has_ignored_connections
-ModelingToolkit.get_ignored_connections
-ModelingToolkit.has_is_discrete
-ModelingToolkit.get_is_discrete
-ModelingToolkit.has_bcs
-ModelingToolkit.get_bcs
-ModelingToolkit.has_domain
-ModelingToolkit.get_domain
-ModelingToolkit.has_var_to_name
-ModelingToolkit.get_var_to_name
-ModelingToolkit.has_gui_metadata
-ModelingToolkit.get_gui_metadata
-ModelingToolkit.has_tag
-ModelingToolkit.get_tag
-```
-
 ## `getproperty` syntax
 
 ModelingToolkit allows obtaining in a system using `getproperty`. For a system `sys` with a

docs/src/API/System_accessors.md

@@ -0,0 +1,148 @@
+# System Accessors
+
+Accessor functions query the information stored in a system. For each field `x`,
+`has_x` checks whether the system contains the field and `get_x` obtains its value.
+
+```@docs
+ModelingToolkit.has_eqs
+ModelingToolkit.get_eqs
+equations
+ModelingToolkit.equations_toplevel
+full_equations
+ModelingToolkit.has_noise_eqs
+ModelingToolkit.get_noise_eqs
+ModelingToolkit.has_jumps
+ModelingToolkit.get_jumps
+jumps
+ModelingToolkit.has_constraints
+ModelingToolkit.get_constraints
+constraints
+ModelingToolkit.has_costs
+ModelingToolkit.get_costs
+cost
+ModelingToolkit.has_consolidate
+ModelingToolkit.get_consolidate
+ModelingToolkit.has_unknowns
+ModelingToolkit.get_unknowns
+unknowns
+ModelingToolkit.unknowns_toplevel
+ModelingToolkit.has_irreducibles
+ModelingToolkit.get_irreducibles
+irreducibles
+ModelingToolkit.has_maybe_zeros
+ModelingToolkit.get_maybe_zeros
+maybe_zeros
+ModelingToolkit.has_state_priorities
+ModelingToolkit.get_state_priorities
+state_priorities
+ModelingToolkit.has_ps
+ModelingToolkit.get_ps
+parameters
+ModelingToolkit.parameters_toplevel
+tunable_parameters
+bound_parameters
+ModelingToolkit.has_brownians
+ModelingToolkit.get_brownians
+brownians
+ModelingToolkit.has_poissonians
+ModelingToolkit.get_poissonians
+ModelingToolkit.has_iv
+ModelingToolkit.get_iv
+ModelingToolkitBase.independent_variable
+ModelingToolkitBase.independent_variables
+ModelingToolkit.has_ivs
+ModelingToolkit.get_ivs
+ModelingToolkit.has_dvs
+ModelingToolkit.get_dvs
+ModelingToolkit.has_tspan
+ModelingToolkit.get_tspan
+ModelingToolkit.has_observed
+ModelingToolkit.get_observed
+observed
+observables
+ModelingToolkit.has_name
+ModelingToolkit.get_name
+nameof
+ModelingToolkit.has_description
+ModelingToolkit.get_description
+ModelingToolkit.description
+ModelingToolkit.has_bindings
+ModelingToolkit.get_bindings
+bindings
+ModelingToolkit.has_initial_conditions
+ModelingToolkit.get_initial_conditions
+initial_conditions
+ModelingToolkit.has_guesses
+ModelingToolkit.get_guesses
+guesses
+ModelingToolkit.has_systems
+ModelingToolkit.get_systems
+ModelingToolkit.has_initialization_eqs
+ModelingToolkit.get_initialization_eqs
+initialization_equations
+ModelingToolkit.has_continuous_events
+ModelingToolkit.get_continuous_events
+continuous_events
+ModelingToolkit.continuous_events_toplevel
+ModelingToolkit.has_discrete_events
+ModelingToolkit.get_discrete_events
+discrete_events
+ModelingToolkit.discrete_events_toplevel
+ModelingToolkit.has_assertions
+ModelingToolkit.get_assertions
+ModelingToolkit.assertions
+ModelingToolkit.has_metadata
+ModelingToolkit.get_metadata
+SymbolicUtils.getmetadata(::ModelingToolkit.AbstractSystem, ::DataType, ::Any)
+SymbolicUtils.setmetadata(::ModelingToolkit.AbstractSystem, ::DataType, ::Any)
+ModelingToolkit.has_is_dde
+ModelingToolkit.get_is_dde
+ModelingToolkit.is_dde
+ModelingToolkit.has_tstops
+ModelingToolkit.get_tstops
+ModelingToolkit.symbolic_tstops
+ModelingToolkit.has_tearing_state
+ModelingToolkit.get_tearing_state
+ModelingToolkit.has_schedule
+ModelingToolkit.get_schedule
+ModelingToolkit.has_isscheduled
+ModelingToolkit.get_isscheduled
+ModelingToolkit.has_index_cache
+ModelingToolkit.get_index_cache
+ModelingToolkit.has_irstructure_tlv
+ModelingToolkit.get_irstructure_tlv
+ModelingToolkit.has_parameter_bindings_graph
+ModelingToolkit.get_parameter_bindings_graph
+ModelingToolkit.does_namespacing
+toggle_namespacing
+ModelingToolkit.iscomplete
+ModelingToolkit.has_preface
+ModelingToolkit.get_preface
+ModelingToolkit.preface
+ModelingToolkit.has_parent
+ModelingToolkit.get_parent
+ModelingToolkit.has_initializesystem
+ModelingToolkit.get_initializesystem
+ModelingToolkit.has_is_initializesystem
+ModelingToolkit.get_is_initializesystem
+ModelingToolkit.is_initializesystem
+ModelingToolkit.has_analytically_integrated
+ModelingToolkit.get_analytically_integrated
+analytically_integrated
+ModelingToolkit.has_connector_type
+ModelingToolkit.get_connector_type
+ModelingToolkit.has_ignored_connections
+ModelingToolkit.get_ignored_connections
+ModelingToolkit.has_is_discrete
+ModelingToolkit.get_is_discrete
+ModelingToolkit.has_bcs
+ModelingToolkit.get_bcs
+ModelingToolkit.has_domain
+ModelingToolkit.get_domain
+ModelingToolkit.has_var_to_name
+ModelingToolkit.get_var_to_name
+ModelingToolkit.has_gui_metadata
+ModelingToolkit.get_gui_metadata
+ModelingToolkit.has_tag
+ModelingToolkit.get_tag
+```