Документация

Установите количество состояний и начальных условий

Используя таблицу Settings, можно задать количество дискретных и непрерывных состояний и их начальные условия.

Можно ввести значения начальных условий в виде списка, разделенного запятыми (для примера, 1,1,1) или как вектор (для примера, [1 1 1]). Количество начальных условий должно быть равно количеству обозначенных состояний.

Установите размещение массива

Установите размещение массива кода C/C + +. Можно выбрать один из опций, перечисленных в таблице.

Выберите режим расчета

Выберите режим расчета вашей S-функции. Режим расчета определяет длину интервала между временами, когда S-функция обновляет свой выход. Можно выбрать один из следующих опций:

Установите количество PWorks

Задайте PWorks, количество указателей данных, используемых S-функцией. PWorks указывает на память в течение жизненного цикла блока. Если вы вводите любое другое значение, кроме 0 для Number of PWorks он добавляет указатель мыши, void **PW, ко всем функциям в S-Function Builder. Например, вы можете объявить и инициализировать указатель на файл или память в Start_wrapper, получите доступ к нему в Outputs_wrapper, Update_wrapper, и Derivatives_wrapper и отключите его в Terminate_wrapper функция. Код, записанный в этих функциях, вызывается mdlStart, mdlOutputs, mdlUpdate, mdlDerivatives, и mdlTerminate методы. Смотрите примеры Скользящее Среднее значение с Началом и Завершение и Сочетание с использованием Классов Cpp в Демонстрациях S-Функций.

Включите доступ к SimStruct

Сделайте SimStruct (S) доступно для функций оболочки, которые использует S-Function Builder. Этот выбор позволяет вам использовать SimStruct макросы и функции с вашим кодом в Outputs_wrapper, Derivatives_wrapper, и Update_wrapper функций. Когда вы включаете эту настройку, SimStruct *S добавляется к списку параметров.

Например, с включенной этой опцией можно использовать макросы, такие как ssGetT в коде, который вычисляет выходы S-функции:

double t = ssGetT(S);
  if(t < 2) 
  {
    y0[0] = u0[0];
  } else 
  {
    y0[0]= 0.0;
  }

Прямое сквозное соединение

Установите флажок Direct Feedthrough в таблице Settings, если значения текущего временного шага входных параметров S-функции используются для вычисления ее выходов. Механизм Simulink использует эту информацию, чтобы обнаружить алгебраические циклы, созданные прямым или косвенным соединением выхода S-функции с входом S-функции.

Вычисление выходов с использованием метода выходов

В S-Function Builder используйте Outputs_wrapper метод для ввода кода, который вычисляет выходы S-функции на каждом временном шаге симуляции. Обратите внимание, что при генерации кода S-функции S-Function Builder генерирует метод-оболочку с использованием имени вашей модели и функцию-оболочку в виде <system_name>_<function_name>_wrapper. Для примера, если имя вашей модели dsfunc_builderметод выхода появляется следующим dsfunc_builder_Output_wrapper в редакторе S-Function Builder. Если у вас еще нет имени для блока S-Function Builder, он появляется следующим system_Output_wrapper.

См. следующий код для примера Outputs метод:

void sfun_Outputs_wrapper(const real_T *u,
                          real_T       *y,
				const real_T *xD, /* optional */
				const real_T *xC, /* optional */
				const real_T  *param0, /* optional */
				int_T p_width0 /* optional */
				real_T  *param1 /* optional */
				int_t p_width1 /* optional */
				int_T y_width, /* optional */
				int_T u_width) /* optional */
{

/* Your code inserted here */
}

где sfun - имя S-функции. S-Function Builder вставляет вызов этой функции оболочки в mdlOutputs метод коллбэка, который он генерирует для вашей S-функции. Механизм Simulink вызывает mdlOutputs метод на каждом времени симуляции или шага расчета для вычисления выхода S-функции. The mdlOutputs метод, в свою очередь, вызывает функцию обертки, содержащую ваш выходной код. Ваш выходной код затем вычисляет и возвращает выход S-функции.

The mdlOutputs метод передает некоторые или все из следующих аргументов в функцию оболочки выходов.

Эти аргументы позволяют вам вычислить выход блока как функцию от его входов и, опционально, его состояний и параметров. Код, который вы вводите в это поле, может вызвать внешние функции, объявленные в файлах заголовка или внешних объявлениях в таблице Libraries, что позволяет вам использовать существующий код для вычисления выходов S-функции.

Обновление дискретных состояний с помощью метода обновления

Используйте Update_wrapper функция для ввода кода, который вычисляет значения дискретных состояний на следующем временном шаге согласно значениям на текущем временном шаге. См. следующий код:

void sfun_Update_wrapper(const real_T *u,
                         const real_T *y,
                         real_T *xD,
                         const real_T  *param0,  /* optional */
                         int_T p_width0, /* optional */
                         real_T  *param1,/* optional */
                         int_T p_width1, /* optional */
                         int_T y_width, /* optional */
                         int_T u_width) /* optional */
{

	/* Your code inserted here. */

}

где sfun - имя S-функции. S-Function Builder вставляет вызов этой функции оболочки в mdlUpdate метод коллбэка, который он генерирует для S-функции. Механизм Simulink вызывает mdlUpdate способ в конце каждого временного шага для получения значений дискретных состояний на следующем временном шаге (см. Simulink Engine Interaction with C S-Functions). На следующем временном шаге механизм передает обновленные состояния обратно в mdlOutputs способ.

The mdlUpdate метод коллбэка, сгенерированный для S-функции, передает следующие аргументы в Update_wrapper функция:

Значения и использование этих аргументов см. в разделе Вычисление выходных параметров с использованием метода выходов. Ваш код должен использовать дискретную переменную состояний, xD, чтобы вернуть значения дискретных состояний, которые он вычисляет. Аргументы позволяют вашему коду вычислять дискретные состояния как функции входов, выходов и, опционально, параметров S-функции. Ваш код может вызвать внешние функции, объявленные в редакторе кода.

Вычисление непрерывных состояний с использованием метода производных

Если S-функция имеет непрерывные состояния, используйте Derivatives_wrapper функция для ввода кода, необходимого для вычисления производных состояний. Введите код для mdlDerivatives функция для вычисления производных редактора непрерывных состояний в этом поле. Пример объявления функции может выглядеть следующим образом:

void system_Derivatives_wrapper(const real_T *u,
				      const real_T *y, 
				      real_T *dx,
				      real_T *xC, 
				      const real_T  *param0,  /* optional */
				      int_T p_width0, /* optional */
				      real_T  *param1,/* optional */
	 			     int_T p_width1, /* optional */
				      int_T y_width, /* optional */
		 		     int_T u_width) /* optional */
{

	/* Your code inserted here. */

}

где system - имя S-функции.

S-Function Builder вставляет вызов этой функции оболочки в mdlDerivatives метод, который он генерирует для S-функции. Механизм Simulink вызывает mdlDerivatives метод в конце каждого временного шага для получения производных непрерывных состояний (см. Simulink Engine Interaction with C S-Functions). Решатель Simulink численно интегрирует производные, чтобы определить непрерывные состояния на следующем временном шаге. На следующем временном шаге механизм передает обновленные состояния назад в mdlOutputs способ. Для получения дополнительной информации о том, как механизм Simulink взаимодействует с S-функциями, смотрите Simulink Engine Interaction with C S-Functions.

mdlDerivatives метод, сгенерированный для S-функции, передает следующие аргументы функции оболочки производных:

The dx аргумент является указателем на массив, ширина которого совпадает с количеством непрерывных производных, заданных на панели Settings. Ваш код должен использовать этот массив, чтобы вернуть значения производных, которые он вычисляет. Смотрите объяснение в разделе Метод вычисления выходов с использованием выходов для значений и использования других аргументов. Аргументы позволяют вашему коду вычислять производные как функцию от входов, выходов и, опционально, параметров S-функции. Ваш код может вызвать внешние функции, объявленные в редакторе кода.

Выделение и удаление памяти с помощью методов запуска и завершения

Используйте Start_wrapper метод записи кода для выделения памяти в начале симуляции. На выделенное ссылаются Pworks для использования во всей S-функции. Точно так же используйте Terminate_wrapper метод для записи кода, чтобы освободить память, выделенную в Start_wrapper способ. Память, на которую ссылаются PWorks могут также быть видны по Terminate, и должны быть освобождены здесь.

Смотрите раздел Set the Number of PWorks, чтобы узнать больше о PWorks.