Engee documentation

General glossary

1-D modelling

  • *1-D modelling.

  • Definition: A method of computer modelling that is limited to the consideration of systems, processes or phenomena in one dimension. In 1D modelling in the Engee environment, a system or object is reduced to a single axis or parameter, and the processes in that system are analysed only along that axis…​.

Block

  • Term in Russian: Block (general definition)

  • Definition: An element that is used in the Engee modelling environment. Blocks are used to model and simulate systems and processes such as electrical circuits, mechanical systems, code generation and others. Depending on their purpose, Engee blocks represent different system components, their interactions and behaviour.

Code Generation

  • *Code Generation.

  • Definition: The process of automatically generating executable C program code. Instead of having the user develop the necessary code themselves, code generation allows code to be generated automatically for further integration into the user’s project. In the Engee environment, code generation is done through a graphical interface in the context menu.

    More details about code generation in Engee can be found at link.

Command Line

  • Termin in Russian: Command Line

  • Definition: A text-based interface that allows you to enter commands and scripts with usage of Julia commands to perform various tasks and operations in the Engee environment. The command line in Engee provides the ability to perform operations without the usage of a graphical user interface, as it is a stand-alone (separate) function.

    You can learn more about the command line at link.

Diagnosis Module

  • Termin in Russian: Diagnosis (module)

  • Definition: A system message handling module in Engee that outputs system messages related to the simulation process. To open the section, click on "Model Diagnostics". The module contains colour coding:

    1. Blue - information message

    2. Yellow - warning

    3. Red - error

    The interface of the diagnostic module is presented at at link.

Dynamic System

  • *Dynamic System.

  • Definition: A system in the Engee modelling environment, which is a mathematical model that describes the change in variables over time. In a dynamic system, the parameters or variables of the system are time dependent and can change in response to external influences or internal processes.

    Such models are used to analyse and simulate various physical, engineering, mathematical and other systems that are subject to changes over time.

Emergency Termination

  • *Emergency Termination.

  • Definition: Termination of a program procedure or its complete stoppage due to a critical error or exception after code processing. In Engee the user may encounter that a programme is forced to terminate or cannot continue due to an error.

    Instructions on how to handle an emergency termination are provided by at link.

HIL (Hardware-in-the-Loop)

  • *Term in Russian: *Half-in-the-Loop modelling.

  • Definition: Real-time simulation of a control object on a separate computer (or computers) running a real-time operating system. Semi-natural simulation allows running a real-time model of the control object with connection to real actuators, sensors and control unit. This allows you to get a full-fledged simulation of the control object. This allows for systematic, full-fledged testing of the system.

    You can learn more about semi-natural modelling at link.

Hard Real-time Model

  • *Hard Real-time Model.

  • Definition: A concept in the field of real-time systems that denotes that a system must strictly adhere to time constraints and ensure that tasks and operations are completed within a strictly defined time frame. An important distinction of hard real-time is that missing time deadlines is considered unacceptable and can have serious consequences.

Ideal Sensor

  • Terminus in Russian: Ideal Sensor

  • Definition: An abstract unit that represents a device capable of measuring system quantities or parameters with high accuracy and without any of the distortion or noise characteristic of real sensors. An ideal sensor is used in models to simplify the modelling and analysis process in Engee and does not exist in the real world.

Ideal Signal

  • *Term in Russian: * Ideal Signal.

  • Definition: An abstract signal that has no time or amplitude constraints and is a mathematical idealised signal used in Engee models to simplify the process of system analysis and simulation. Such models have no physical equivalent in the real world and serve only to simplify the mathematical analysis and modelling of the system in the Engee user’s project.

Ideal Source

  • Terminus in Russian: Ideal Source.

  • Definition: An abstract element of the Engee modelling environment that represents a signal source that has no internal resistance or other subjective limitations. It is capable of producing signals with constant or variable values of voltage, current or other parameters without any loss, which makes it ideal (and not existing outside the software environment).

    An ideal source does not take into account factors such as internal resistance, inductance, capacitance, and other electrical characteristics that are bound to exist in real sources.

Initial Condition

  • Termin in Russian: Initial Value

  • Definition: A variable for functional blocks in the Engee environment that refers to the initial values of the block state variables before the simulation starts. The Engee state variables may represent physical parameters of the system or other intermediate variables that affect the behaviour of the block during the simulation. Setting initial conditions is particularly important when modelling dynamic systems where the simulation is started at an initial point in time.

    The initial value can be set for various parameters such as positions, velocities, currents, and other system characteristics. These parameters depend on the type of the particular unit and its application.

Interactive Script

  • Termin in Russian: Interactive Script

  • Definition: An interactive shell environment in Engee that allows the user to work with Markdown and LaTeX markup language text and code. The user can manipulate sections of script, add new scripts, and run them.

    For more information on interactive scripts, see link.

Library

  • *Library

  • Definition: A set of functions, commands and modules (blocks) intended for usage in the Engee software environment. The library provides ready-made components that can be incorporated into a user project to perform specific tasks.

Local Repository

  • Termin in Russian: Local Repository

  • Definition: A copy of a remote repository that is stored on the user’s local Engee computer. A repository in the context of a version control system (most commonly Git), is a repository for source code and change history.

Magnetic Port

  • *♪ Magnetic Port

  • Definition: A port in the Engee environment that is used to simulate magnetic interactions and transfer magnetic flux between model components.

    Magnetic ports allow you to create models of magnetic systems including electromagnetic devices, transformers, solenoids, and other devices where magnetic fields must be accounted for in order to run a correct simulation.

Model Hierarchy

  • *Model Hierarchy.

  • Definition: A concept in Engee which is the ability to combine blocks into a subsystem. Within one subsystem, an unlimited number of other subsystems can be created at different levels of nesting. As a result, the model has a hierarchy.

    For more information on model hierarchy and subsystem creation, see link.

Model Reference

  • Term in Russian: Model Reference

  • Definition: Block Model.

Multirate System

  • *Multirate System.

  • Definition: A system in which different blocks and/or signals operate at different sampling frequencies.

    Multirate systems are used where some components can operate at a higher sampling rate than others.

Muxed Signal

  • *♪ Muxed Signal

  • Definition: A method of combining multiple signals into a single signal or data stream. Combining data from different blocks and/or from different ports of Engee models into one common signal that can be passed to other subsystems for analysis and processing.

Parallel Computing

  • *Parallel Computing.

  • Definition: A method of computational task execution in Engee projects using Julia, where tasks are executed concurrently rather than sequentially. The method significantly improves computational performance with GPU computing, multithreading, multitasking processes, and asynchronous tasks.

    Learn the basics of parallel computing at link.

Physical Port

  • *Physical Port.

  • Definition: An interface for the transmission of physical signals between blocks of a modelled system in the Engee environment. It defines how a physical signal enters or leaves the system and what parameters are associated with that signal. Physical ports allow the establishment of links between components and the transfer of physical influences and data between them.

Pipeline processing

  • Term in Russian: Pipeline processing.

  • Definition: An approach to data processing on Julia in Engee that describes a sequence of steps for outputting images (graphs) when working with code on Julia. There are six steps in total:

    1. Pre-processing of attributes

    2. Input data processing: custom templates, grouping, and more

    3. Initialising and updating the schedule and sub-schedules

    4. row templates

    5. Preparing for output

    6. Display

    Separately for each stage you can read the section "Development Pipeline" at link.

Pneumatic Port

  • *Pneumatic Port.

  • Definition: A port on Engee blocks that is used to model pneumatic systems and transfer pneumatic signals and their parameters between blocks in a user project. Pneumatic ports allow you to create models of pneumatic systems, including pneumatic actuators, valves, cylinders, and other devices that use compressed air control.

Prediction Model

  • Termin in Russian: Prediction Model.

  • Definition: A model that is used to predict the values and behaviour of a future system based on available data. The model may include predicting future signals, time series, system state, and other parameters that the Engee user may set to work with the project simulation.

Real-time Machine

  • *Real-time machine.

  • Definition: A concept in the field of real-time systems that implies that the system is oriented to perform tasks within specified time limits, but can tolerate minor violations of time constraints without serious consequences.

Rotational Port

  • *Rotational port.

  • Definition: A port of blocks in the Engee environment that is used to model rotational motion and mechanical power transfer between blocks in mechanical systems of user projects. Rotational ports allow you to describe rotational components such as shafts, motors, rotors, and other devices that rotate about an axis.

    Rotational ports contain information about angular velocity, angle of rotation, moment of inertia, and other metrics that describe the state of rotational components.

Signal Port

  • *Signal Port.

  • Definition: An input or output of a Engee model block that is used to transfer signals between blocks. Signal ports are used for signals between different parts of the model and define the flow of information within the model.

Simulation

  • *Simulation.

  • Definition: The process of simulating and analysing the behaviour of a system model in the Engee environment. During the simulation, the system model performs a certain task and its behaviour is analysed according to the parameters and data set. Simulation allows predicting how the system will behave in real world conditions without actually implementing it in the field.

Soft Real-time Model

  • *Soft Real-time Model.

  • Definition: A concept in the field of real-time systems that implies that the system is oriented to perform tasks within specified time limits, but can tolerate minor violations of time constraints without catastrophic consequences. Unlike hard real-time, where missing deadlines is considered unacceptable, soft real-time allows some degree of flexibility and can deliver results with delay or loss in quality.

Solution processing

  • Termin in Russian: Solution processing.

  • Definition: Analysing the results obtained after performing computational problems or solving equations by usage of solvers in Engee environment. The solution processing process consists of successive steps of importing, processing and analysing solutions.

    You can familiarise yourself with solution processing at link.

    Read the processing pipelines at link.

Solver

  • *♪ Resolver

  • Definition: An algorithm or method in the Engee environment that is used to numerically integrate differential equations and provide simulation models in user projects. The solver determines how the system evolves over time, how variable values are updated, and how often calculations are performed to simulate the system.

System Component

  • Term in Russian: System Component.

  • Definition: A part of a system that interacts with other parts. The interactions between components determine the structure and behaviour of the system.

    For example, a cruise control module is a system component in a vehicle system. The microcontroller and associated hardware determine the structure, and the software algorithm for speed control determines the behaviour.

Thermal Port

  • *Thermal Port.

  • Definition: A block port in the Engee environment designed for modelling thermal interactions and heat transfer between elements in systems where heat transfer and thermal dependencies must be accounted for for correct simulation. Thermal ports allow you to create designs that account for thermal processes and heat transfer in the Engee system.

Three-Phase Port

  • *Three-phase port.

  • Definition: A port in the Engee environment that is used to communicate with three-phase electrical systems. Three-phase systems are widely used in power generation, industry, and other applications where power transmission and distribution is required.

Translational Port

  • *Translational port.

  • Definition: A port of blocks in the Engee environment that is used to simulate translational motion and transfer mechanical power between other blocks in a user’s project in mechanical systems.

    The progressive port is used to describe the motion of solids and their interactions in a system with mechanical motion.

User Account

  • Termin in Russian: Personal Account

  • Definition: An online profile created by a user to manage their account, settings and resources related to usage of Engee. All features are available to the user after registering with the Engee system.

    More information about the personal profile can be found at link.

Visualisation

  • *Visualisation.

  • Definition: A function in the Engee simulation environment responsible for visualising the results at the end of a signal simulation. Visualisation occurs automatically when you start the "Visualise" function in the pop-up menu when you move the cursor over a model signal line.

    More details on visualisation in Engee can be found at link.

Workspace

  • *Workspace.

  • Definition: The environment in which the main user work with model data (blocks, files, simulations) within the current project takes place. The workspace is a tool for linking and further work with the various components of the model project, scenarios and simulations in Engee.

    More details about the workspace in Engee can be found at link.