Holarch

SysML v2

Метаданные моделирования в проектах SysML v2

Библиотека метаданных HolarchSimulation: как модель SysML v2 хранит длительности, вероятности ветвей, число повторений циклов, ресурсы, затраты и настройки конечных автоматов для Симулятора, и как их записывать и переносить.

Как использовать →

На этой странице
  1. Обзор
  2. Понятия
    1. Номинальное значение и распределение
    2. Какие настройки имеют приоритет
    3. Два симулятора
  3. Как использовать
    1. Когда и зачем
    2. Задать длительность, вероятность или число проходов цикла
    3. Написать аннотации в тексте
    4. Перенести старые настройки в модель
    5. Моделировать машину состояний
    6. Разобранный пример: демо-проект Hybrid Car
    7. Советы и рекомендации
    8. Типичные ошибки
    9. Как это связано с остальным
  4. Аннотации
    1. Распределения
    2. Коррелированные входы
    3. Вероятности и количества
    4. Ресурсы и затраты
    5. Аннотации, требующие движка SysML
  5. Сообщения
  6. Ограничения
  7. Связанные материалы

Обзор

В проекте SysML v2 настройки Симулятора являются частью модели. Это аннотации метаданных из библиотечного пакета HolarchSimulation, который загружается в каждом проекте SysML v2. Модель, использующая их, остаётся корректной моделью SysML v2: другие инструменты читают аннотации как обычные метаданные, и только Симулятор придаёт им смысл.

Аннотация либо находится внутри аннотируемого элемента, либо называет этот элемент через about:

succession toCruise first shift if speed > 30 then cruise {
  @HolarchSimulation::Probability { percent = 70; }
}
metadata HolarchSimulation::Cost about DriveCycle::drive { amount = 0.4; unit = "USD"; label = "Energy"; }

Понятия

Номинальное значение и распределение

Длительность шага — это его атрибут duration (или атрибут типа DurationValue или TimeValue). Его значение — номинальная длительность, которую видят другие инструменты и вычисление Holarch. Аннотация распределения на этом атрибуте заставляет Симулятор вместо этого разыгрывать длительность:

action cruise {
  attribute duration : ISQ::DurationValue = 1 [min] {
    @HolarchSimulation::Triangular { low = 45 [s]; mode = 1 [min]; high = 2 [min]; }
  }
}

Какие настройки имеют приоритет

  • Аннотация распределения имеет приоритет над собственным значением атрибута.
  • Условие, условие if или условие цикла, которое модель может вычислить, решает само. Probability или LoopCount используются, только если вычислить нельзя (LoopCount всегда подсчитывает проходы).
  • Настройки, сделанные до того, как настройки моделирования перешли в модель, хранятся как данные Holarch рядом с моделью. Они по-прежнему имеют приоритет, поэтому прогоны дают те же результаты, пока вы их не перенесёте (см. Перенести старые настройки в модель).

Два симулятора

Страница «Симулятор» справа от настроек показывает, какой симулятор выполняет модель: Движок SysML (симулятор Holarch Language Engine) или Симулятор JavaScript. Оба читают одни и те же аннотации. Машины состояний, стимулы, ресурсы из Resource, Consumes, Produces и Seizes, затраты из Cost и другие аннотации из раздела Аннотации, требующие движка SysML выполняются только с движком SysML.

Как использовать

Когда и зачем

Записывайте настройки моделирования в модель, когда модель служит записью проекта: числа переносятся вместе с файлами .sysml, видны при рецензировании текста и версионируются вместе с остальной моделью. Используйте их при анализе операционного сценария (временные шкалы, доли ветвей, использование ресурсов) и перед проверкой требования по исследованию Монте-Карло.

Задать длительность, вероятность или число проходов цикла

  1. Выделите шаг, последовательность, решение, цикл или действие if в представлении Action Flow, в Браузере или в Редакторе.
  2. В разделе Моделирование инспектора задайте Длительность (фиксированное значение или распределение), Вероятность (%), Итерации или Вероятность then (%).
  3. Holarch записывает аннотацию в модель: Длительность задаёт значению атрибута среднее и добавляет аннотацию распределения (или записывает attribute duration : ISQ::DurationValue, если у шага его нет); Вероятность (%) записывает Probability; Итерации записывает LoopCount. Каждое изменение отменяется одним нажатием “Отменить” и сразу появляется в тексте.
  4. Очистите поле, чтобы удалить его аннотацию.

Holarch проверяет каждое изменение средством проверки SysML перед записью. Изменение, которое добавило бы ошибку, не записывается, и сообщение называет проблему.

Написать аннотации в тексте

  1. Откройте Редактор.
  2. Добавьте аннотацию внутри тела элемента как @HolarchSimulation::Kind { field = value; } или после него как metadata HolarchSimulation::Kind about element { … }.
  3. Для Consumes, Produces и Seizes сначала назовите шаг, затем ресурс: metadata HolarchSimulation::Consumes about DriveCycle::drive, DrivenCar::powertrain::battery { amount = 1.5; }.

Перенести старые настройки в модель

Проекты, настройки моделирования которых были сделаны до их переноса в модель, показывают над настройками Симулятора сообщение Некоторые настройки моделирования этого проекта — данные Holarch, а не часть модели.

  1. Нажмите Перенести настройки симуляции в модель….
  2. Предпросмотр перечисляет каждую настройку и аннотацию, которая её заменяет.
  3. Нажмите Перенести в модель. Все настройки переносятся, и одно нажатие “Отменить” возвращает всё назад; прогоны дают те же результаты.

Моделировать машину состояний

Машины состояний выполняются с движком SysML.

  1. Откройте Поведение → Симулятор и выберите в качестве Корень определение состояния или часть, демонстрирующую состояния.
  2. Необязательно: в поле Выполнять вместе с выберите действие-сценарий, которое отправляет части сигналы, например TestDrive из демо-проекта.
  3. В разделе Стимулы нажмите + Добавить стимул и задайте В (время и единицу), Сигнал и Куда (машину или Каждая машина, которая его принимает).
  4. Нажмите ▶ Воспроизвести, ⏭ Шаг или ⏩ Выполнить до конца. Машина состояний в ходе выполнения подсвечивает активные состояния и отмечает сработавший переход; вкладка Состояния показывает Состояния во времени и Сработавшие переходы.
  5. В режиме Монте-Карло вкладка Состояния показывает Время в состоянии и Число переходов. Проверить по требованию… предлагает в качестве выходов время в каждом состоянии и его долю в прогоне.

В представлении переходов состояний ▶ Моделировать открывает панель с кнопками ▶ Воспроизвести, ⏭ Шаг, ⏩ Выполнить до конца, Сбросить и Открыть в симуляторе. Прогон использует стимулы, сохранённые в Симуляторе для этого определения состояния.

Разобранный пример: демо-проект Hybrid Car

Демо-проект Hybrid Car («Управление проектами» → Файлы проектов ▾ → Новый демо-проект) использует библиотеку:

  • DriveCycle: у последовательности toCruise после shift Probability 70; ветвь else берёт оставшиеся 30 %. cruise номинально занимает 1 мин и разыгрывается из распределения Triangular (45 с, 1 мин, 2 мин).
  • DrivenCar: батарея силовой установки — это Resource на 62 Вт·ч; drive Consumes 1,5 Вт·ч из неё, и у него Cost 0,4 USD за использование.
  • PowertrainStates: у перехода startElectric Probability 80 для его условия; accept when charge < 15 переключает в гибридный режим, когда заряд падает; accept after 30 [min] завершает зарядку.
  • TestDrive: сценарий, который отправляет StartRequest, ждёт час, затем отправляет StopRequest и PlugIn в demoCar. Запустите Demo Car вместе с Test Drive, чтобы увидеть смену состояний силовой установки.

Демо-проект проверяется с 0 диагностик.

Советы и рекомендации

  • Делайте номинальное значение осмысленным: задавайте его равным математическому ожиданию распределения, как это делает инспектор.
  • Давайте имена аннотируемым последовательностям (succession toCruise first …), чтобы аннотацию было легко найти в тексте.
  • Предпочитайте вероятностям условия, которые модель может вычислить; используйте Probability для того, что модель не описывает.

Типичные ошибки

  • Вероятность ни на что не влияет: условие можно вычислить, поэтому решает оно. Инспектор сообщает «Вычисляется в true: выбирается всегда.» или «Вычисляется в false: не выбирается никогда.»
  • Вероятности ветвей в сумме не дают 100 %: ветви без Probability делят остаток; когда заданные превышают 100 %, предупреждение гласит «Branch probabilities add up to N %. Change them to total 100 %.»
  • Аннотация длительности на самом шаге: распределения относятся к атрибуту длительности, а не к действию.

Как это связано с остальным

Аннотации

Распределения

Помещайте распределение на атрибут длительности. Поля положения и масштаба принимают величину с единицей (45 [s], 2 [min]); поля формы принимают число.

АннотацияПоляЗначение
Нормальноеmean, sdНормальное распределение.
Треугольноеlow, mode, highТреугольное, low ≤ mode ≤ high.
Равномерноеlow, highРавномерное между low и high.
ExponentialmeanЭкспоненциальное с заданным средним.
Gammashape, scaleГамма-распределение; среднее равно shape × scale.
LogNormalmedian, sigmaЛогарифм распределён нормально вокруг логарифма медианы.
Weibullscale, shapeРаспределение Вейбулла.
Betaalpha, beta, scaleБета-распределение на 0..1, умноженное на scale.
Poissonmean, scaleКоличество с заданным средним, умноженное на scale.
Binomialtrials, p, scaleЧисло успехов в серии испытаний, умноженное на scale.

Длительности, выпавшие ниже нуля, разыгрываются заново.

Коррелированные входы

Без корреляции каждое значение, разыгранное из распределения, не зависит от других. Correlation заставляет два из них меняться согласованно:

metadata HolarchSimulation::Correlation about findCharger::duration, charge::duration { coefficient = 0.6; }
АннотацияНа чёмЗначение
Correlation coefficientabout a, b: два атрибута, каждый с распределениемРанговая корреляция (Спирмена) их значений от -1 до 1. 0 — независимы, 1 — всегда ранжируются одинаково, -1 — противоположно.
  • Каждый атрибут сохраняет своё распределение. Симулятор объединяет все пары в одну корреляционную матрицу (гауссова копула): n-е значение, разыгранное для атрибута в прогоне, сочетается с n-м значением каждого коррелированного с ним атрибута.
  • Коэффициенты группы коррелированных атрибутов должны быть согласованы: a сильно с b, b сильно с c, но a противоположно c — невозможно. Проверка сообщает о такой группе; ослабьте один из коэффициентов.
  • Длительности и количества (Consumes, Produces, Seizes) коррелируют одинаково. Прогон с тем же начальным значением даёт те же значения.
  • В Симуляторе в режиме Монте-Карло с движком SysML раздел Коррелированные входы перечисляет пары корня. Выберите два атрибута и коэффициент и нажмите + Добавить корреляцию, измените коэффициент или нажмите ×, чтобы удалить пару; каждое изменение отменяется одним нажатием “Отменить”. После исследования Достигнуто показывает ранговую корреляцию разыгранных в прогонах значений.
  • ChargeStop в демо-проекте Hybrid Car коррелирует ожидание свободного зарядного устройства со временем зарядки (0,6).

Вероятности и количества

АннотацияНа чёмЗначение
Probability percentПоследовательность, выходящая из решенияВес ветви. Ветви без веса делят остаток от 100.
Действие ifВероятность ветви then, если условие нельзя вычислить.
Действие циклаВероятность повтора после каждого прохода.
ПереходВероятность того, что его условие выполняется, если условие нельзя вычислить.
LoopCount countДействие циклаЧисло проходов; имеет приоритет над условиями цикла.
LoopExitПоследовательность к done в теле циклаЗавершает весь цикл, а не только проход.

Ресурсы и затраты

АннотацияНа чёмЗначение
Resource initial, minimum, maximum, unitИспользование части или предметаПул некоторого количества. Если использование объявляет attribute level : Real, симулятор поддерживает его равным количеству, чтобы условия могли его читать.
Consumes amountabout step, poolЗабирается при начале шага.
Produces amountabout step, poolДобавляется при окончании шага.
Seizes amountabout step, poolЗабирается при начале шага и возвращается при его окончании.
Utilization amountИспользование действия performКакую долю выполняющей части занимает шаг.
Cost amount, rate, unit, labelШаг или выполняющая частьЗатраты за использование (CostRate::perUse) или за час (CostRate::perHour).

Аннотации, требующие движка SysML

АннотацияЗначение
Transfer latency, capacity, perНа соединении или интерфейсе: задерживает предметы и сигналы, передаваемые по нему.
Size sizeНа предмете: его размер для задержек передачи.
Timeout limitНа слиянии: останавливает незавершённые ветви по истечении предела.
NotBefore timeНа шаге: шаг не начинается раньше этого времени прогона.
ForkTargets, JoinSourcesНа переходе в параллельное состояние или из него: подсостояния, в которые выполняется вход, или подсостояния, которые должны быть активны.
History deepНа составном состоянии: повторный вход возобновляет подсостояние, активное в момент выхода.
HostHook key, pointsЗарезервировано для Holarch: прогон приостанавливается для ввода в перечисленных точках.

Симулятор JavaScript читает Probability, LoopCount и распределения.

Сообщения

СообщениеЗначение
Некоторые настройки моделирования этого проекта — данные Holarch, а не часть модели.Старые настройки всё ещё хранятся рядом с моделью. Нажмите Перенести настройки симуляции в модель….
Данные Holarch, созданные до переноса настроек моделирования в модель; они имеют приоритет над моделью.Показывается в разделе Моделирование инспектора. Измените поле, чтобы записать его в модель, или перенесите все настройки в Симуляторе.
В модели нет длительности. Задайте её здесь (будет записано attribute duration : ISQ::DurationValue) или напишите в тексте.У шага нет атрибута длительности.
@Normal: sd must be greater than zero. Change sd. (и аналогично для других распределений и параметров)Параметр распределения отсутствует или вне допустимого диапазона. С движком SysML проверка модели сообщает об этом в Редакторе, а Симулятор отказывается выполняться, пока это не исправлено.
@Normal: sd has another unit dimension than …Параметр положения или масштаба имеет другие единицы, чем атрибут, например метры у длительности.
@LoopCount does not apply to a part …Аннотация находится на элементе такого вида, к которому она не применяется. Переместите или удалите её.
metadata Consumes … about needs an action and a part or item annotated @Resource.Элементы после about неверны по количеству или виду.
A probability of N % is outside 0 to 100.Введите процент от 0 до 100.
The branch probabilities of this decision add up to N %; the simulator scales them to 100 %.Предупреждение: у каждой ветви есть вес, и в сумме они не дают 100.
A correlation needs two different attributes …, … is not an attribute … или … has no distribution, so nothing is drawn to correlate …Correlation дважды называет один атрибут, называет то, что не является атрибутом, или атрибут без распределения.
The coefficient N is outside -1 to 1. или The correlation has no coefficient.Введите коэффициент от -1 до 1.
“a” and “b” are already correlated; the first correlation is used. …Предупреждение: вторая Correlation той же пары игнорируется. Удалите одну из двух.
The correlations of … contradict each other: no joint distribution has them …Коэффициенты группы не могут выполняться одновременно (матрица не является положительно полуопределённой). Ослабьте один из них. Симулятор отказывается выполняться, пока это не исправлено.
Deadlock at <time>: N steps wait for something that never comes.Показывается над результатами с движком SysML вместе с каждым ожидающим шагом. accept без отправителя, предмет, который никогда не производится, или ресурс, который никогда не освобождается, останавливают прогон.

Ограничения

  • Длительности записываются в секундах, минутах, часах или сутках (SI::s, SI::min, SI::h, SI::d). Миллисекунды записываются как секунды; недели, месяцы и годы — как сутки.
  • Машины состояний, стимулы и Выполнять вместе с требуют движка SysML.
  • Коррелированные входы требуют движка SysML; симулятор JavaScript разыгрывает каждое значение независимо. В одной группе можно коррелировать не более 200 атрибутов.
  • Проверка противоречивых коэффициентов охватывает корреляции, записанные в одном пространстве имён; Симулятор проверяет все корреляции прогона.

SysML® и OMG® — зарегистрированные товарные знаки Object Management Group, Inc. в США и других странах.