Model System Schema Usage Guidelines¶
Required Rules¶
-
Exactly one representative system per simulation context. Do: set
is_representative=Trueonly on the primary system. Do not: mark derived/contextual systems representative by default. Reference: Model System, Normalization -
Keep vertical and lateral structure separate. Do: use
sub_systemsfor physical decomposition (ModelSystem -> ModelSystem). Do: userepresentationsfor alternative geometric views (ModelSystem -> AlternativeRepresentation). Do not: encode hierarchy insiderepresentationsor alternatives insidesub_systems. Reference: Model System, Representation Architecture -
Keep parser-native geometry on the root system. Do: store original parser geometry directly on the root
ModelSystem. Do: store generated/transformed variants inrepresentations. Do not: overwrite parser-native geometry during normalization. Reference: Representation Architecture, Normalization -
Reuse structure by reference instead of duplication. Do: define structural descriptors once in
ModelSystem. Do: reference those sections from methods/outputs where possible. Do not: duplicate equivalent structural data across branches. Reference: Model System -
Use normalization for completion and validation. Do: derive missing descriptors and run consistency checks. Do not: silently rewrite explicit parser intent. Reference: Normalization
-
Keep documentation invariants synchronized. Do: update affected explanation pages in the same PR when usage rules change. Do: keep this page as policy-only and move long examples elsewhere. Reference: Model System, Representation Architecture, Documentation Writing Guide
Contributor Note
This page defines required usage rules for ModelSystem and should stay
concise. Keep long implementation details and extended examples in linked
pages.