Webel: SysML4Mathematica: Does every bit of the Mathematica code need to be modelled in SysML? No. Typically just the main function parameters and their interdependencies, data structures, and main code logic. Except for special or educational purposes.

Webel IT Australia promotes the amazing Mathematica tool and the powerful Wolfram Language and offers professional Mathematica services for computational computing and data analysis. Our Mathematica tips, issue tracking, and wishlist is offered here most constructively to help improve the tool and language and support the Mathematica user community.
DISCLAIMER: Wolfram Research does not officially endorse analysis by Webel IT Australia.
Icon class
icon_class
far fa-sticky-note
icon_class_computed
far fa-sticky-note
Note kind
MODELLING
NAMING
TIP
Policy level
RECOMMENDED
Specification keywords
SysML-1.6
SysML-1.7
UML-2.5.1
UML keywords
Activity
OpaqueBehavior
SysMLv1.x keywords
ConstraintBlock
Keywords

In the Webel recipe for modelling Mathematica (Wolfram Language) code in Systems Modeling Language v1 (SysML®) it is not intended that every single little part of the Wolfram Language code be modelled in SysML, even if there are some examples of fine-grained modelling of code on this site (mostly for educational purposes):

Webel: SysML/UML: Some example diagrams show extremely fine-grained and trivial examples purely for educational and capability demonstration purposes (not as practical recommendations for real-world projects). You can sometimes just use code in SysML.

A function can be captured in SysML as an OpaqueBehavior with a 'body' or a ConstraintBlock with a Constraint indeed capturing the code (and even in Wolfram Language), which can be invoked in Magic Model Analyst® (Cameo Simulation Toolkit®) with Mathematica as the external maths engine, and serves as an excellent record of the function signature. Both Behaviors (OpaqueBehaviors) and Activities can be shown on a Block Definition Diagrams (BDD) in SysMLv1, including their parameters and constraint parameters and relationships to other elements.

Or the actual function call signature can be used (works with parameters with simpler types), and can be invoked in Magic Model Analyst® (Cameo Simulation Toolkit®) with Mathematica as the external maths engine.

For more complex functions and code logic, an Activity may be used, whereby it is not always necessary to model the internals with a SysML Activity Diagram:

Visit also: Webel: SysML4Mathematica: An '@' prefix in the name of a ConstraintBlock, Activity, or OpaqueBehavior indicates that it is not represented by a dedicated function in a Mathematica code library (typically for minor maths or logic)
Visit also: Webel: SysML4Mathematica: When modelling the logic flow of Mathematica code with Activity diagrams it is not necessary to model every single Mathematica construct. Placeholder OpaqueBehaviors (used via CallBehaviorActions) and OpaqueActions may be used.
Relates to
SysML4Mathematica: Psychrometrics (humid air physics) Air Conditioning scenarios in graphical Systems Modeling Language (SysMLv1.x) and Mathematica
SysML4Mathematica: Example: Block Definition Diagram overview of ConstraintBlocks, their parameters, and ConstraintBlock usages representing lower-level Webel Psy library Psychrometrics functions and CoolProp wrapper usages
Related notes
[CAPABILITY, FEATURE, MODELLING, TIP, TOOL]{RECOMMENDED} Cameo Simulation Toolkit: You can use Mathematica as an external maths engine to share maths between an OpaqueBehavior and a ConstraintBlock using custom auto-loaded Mathematica functions (keeps a project nice and DRY and respects Single Source of Truth)
[QUESTION, TIP, TOOL]{TIP} HOWTO access custom (user-defined) Mathematica functions using Mathematica v13.2 as an external maths engine for SysML Parametrics (ConstraintBlocks) in Magic Model Analyst (Cameo Simulation Toolkit) versions 2021x, 2021xR1, 2022xR1
[TIP, TOOL] HOWTO use Mathematica v12.3.2 as an external maths engine for SysML Parametrics (ConstraintBlocks) in Magic Model Analyst (Cameo Simulation Toolkit) versions 2021x, 2021xR1, 2022xR1
[EXPLANATION, MODELLING]{INFORMATIVE} Webel: SysML/UML: Some example diagrams show extremely fine-grained and trivial examples purely for educational and capability demonstration purposes (not as practical recommendations for real-world projects). You can sometimes just use code in SysML.
[CONVENTION, MODELLING, NAMING]{RECOMMENDED} Webel: SysML4Mathematica: An '@' prefix in the name of a Block indicates a Mathematica data structure (such as an Association or List) that is not represented by an MTools class in the Mathematica code
[CONVENTION, MODELLING, NAMING]{RECOMMENDED} Webel: SysML4Mathematica: An '@' prefix in the name of a ConstraintBlock, Activity, or OpaqueBehavior indicates that it is not represented by a dedicated function in a Mathematica code library (typically for minor maths or logic)
[CONVENTION, MODELLING, NAMING]{RECOMMENDED} Webel: SysML4Mathematica: When modelling the logic flow of Mathematica code with Activity diagrams it is not necessary to model every single Mathematica construct. Placeholder OpaqueBehaviors (used via CallBehaviorActions) and OpaqueActions may be used.
Related notes (backlinks)
Related snippets (extracts)
Visit also
Mathematica zone
Visit also (backlinks)