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

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

С помощью таблицы Настройки (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-функций используйте 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-функций вставляет вызов этой функции-оболочки в mdlOutputs метод обратного вызова, который он генерирует для вашей S-функции. Движок Simulink вызывает mdlOutputs способ на каждом этапе моделирования или времени выборки для вычисления вывода S-функции. mdlOutputs метод, в свою очередь, вызывает функцию-оболочку, содержащую выходной код. Код вывода вычисляет и возвращает вывод S-функции.

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

Эти аргументы позволяют вычислять выходные данные блока как функцию его входных данных и, необязательно, его состояний и параметров. Код, введенный в это поле, может вызывать внешние функции, объявленные в файлах заголовков или внешних объявлениях в таблице Библиотеки, что позволяет использовать существующий код для вычисления выходных данных 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-функций вставляет вызов этой функции-оболочки в mdlUpdate метод обратного вызова, который он генерирует для S-функции. Движок Simulink вызывает mdlUpdate способ в конце каждого временного шага для получения значений дискретных состояний на следующем временном шаге (см. Simulink Engine Interaction with C S-Functions). На следующем шаге времени движок передает обновленные состояния обратно в mdlOutputs способ.

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

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

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

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

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

Дополнительные сведения см. в разделе Установка количества PWorks PWorks.