simulink中S-Function的说明及应用举例

由于仿真需求，学习S-Function模块，开始看它的help文档，看的一头雾水（主要是自己英文不好）。然后网上找到了一个大神写的关于S-Function的说明使用，觉得写的非常清晰明白，就转载过来了。

1 、S函数介绍

S函数：是 S-Function（system Function）的简称。

作用：利用MATLAB的丰富资源，而不仅仅局限于simulink提供的模块，用 matlab、c、c++等语言，
写自己的simulink模块。s函数还可以实现对硬件端口的操作，还可以操作Windows API等。

写作语言：matlab、c、c++、Fortran等。这里主要介绍用MATLAB写，因为它简单。

为了理解S函数，先介绍下simulink的仿真过程。

2、simulik仿真过程

simulink仿真过程包含两个阶段：

1. 初始化阶段——这个阶段主要设置一些参数，如系统的输入输出个数，状态初值、采样时间等；

2. 运行阶段——这个阶段里要进行计算输出，更新离散状态、计算连续状态等等，这个阶段需要反复运行，直至结束；

3、S函数模板分析

模板打开：在MATLAB的workspace中输入 edit sfuntmpl，就可以打开MATLAB提供的s函数模板。

它的第一行：function [sys,x0,str,ts,simStateCompliance] = sfuntmpl(t,x,u,flag)

输入与输出变量的含义， t：采样时间、x：状态变量、u：输入（做成simulink模块的输入）、flag：仿真过程中的状态标志（以它来判断当前是初始化还是运行等）；
sys：是输出根据flag的不同而不同（下面会结合flag来讲sys的含义）、x0：状态变量的初始值、
str：保留参数，在初始化时将它置空就可以了、ts：一个1x2的向量，ts(1)：采样周期、ts(s)：偏移量。

下面结合模板中的代码来讲具体的结构：

function [sys,x0,str,ts,simStateCompliance] = sfuntmpl(t,x,u,flag)

switch flag,            %判断flag,看当前处于哪个状态
  case 0,               %表示处于初始化状态，此时用mdlInitializeSizes进行初始化
    [sys,x0,str,ts,simStateCompliance]=mdlInitializeSizes; 
  case 1,               %表示此时要计算连续状态的微分，即上面提到的dx/dt=fc(t,x,u)中的dx/dt，
    sys=mdlDerivatives(t,x,u);
  case 2,               %表示此时要计算下一个离散状态，我们这儿可以改为sys=fd(t,x(2),u)或者
                        %sys=H*x(2)+G*u,sys即为x(k+1)
    sys=mdlUpdate(t,x,u);
  case 3,               %此时要计算输出，即y=fo(t,x,u)，找到这个函数
    sys=mdlOutputs(t,x,u);
  case 4,              %此时要计算下一次采样时间，只在离散变步长系统中有用
                       %(即上文的，初始化中提到的ts设置ts(1)不为0)
    sys=mdlGetTimeOfNextVarHit(t,x,u);
  case 9,              %表示此时系统要结束，一般来说在mdlTerminate函数中写sys=[]就可，
                       %如果你在结束时要设置什么，就在次函数中写
    sys=mdlTerminate(t,x,u);
  otherwise
    DAStudio.error('Simulink:blocks:unhandledFlag', num2str(flag));

end


function [sys,x0,str,ts,simStateCompliance]=mdlInitializeSizes  
 %在初始化状态下，sys是一个结构体， 
 %用它来设置模块的一些参数，各个参数详细说明如下
sizes = simsizes;           %用于设置模块参数的结构体用simsizes来生产
sizes.NumContStates  = 0;   %模块连续状态变量个数
sizes.NumDiscStates  = 0;   %模块离散状态变量个数
sizes.NumOutputs     = 0;   %模块输出变量个数
sizes.NumInputs      = 0;   %模块输入变量个数
sizes.DirFeedthrough = 1;   %模块是否存在直接贯通（直接贯通我的理解是输入能直接控制输出）
sizes.NumSampleTimes = 1;   %模块的采样时间个数，至少一个

sys = simsizes(sizes);      %设置完后赋给sys输出

% 举个例子 考虑如下模型：dx/dt=fc(t,x,u) 
% 用连续状态方程描述：   dx/dt=A*x+B*u
% x(k+1)=fd(t,x,u)
% 用连离散状态方程描述：x(k+1)=H*x(k)+G*u(k)
% y=fo(t,x,u) 也可以用输出状态方程描述：y=C*x+D*u
% 设上述模型连续状态变量、离散状态变量、输入变量、输出变量均为1个，
% 我们就只需要改上面那一段代码为：
% sizes.NumContStates  = 1; sizes.NumDiscStates  = 1; sizes.NumOutputs =
% 1;sizes.NumInputs = 1; 其他的可以不变
%（一般连续状态和离散状态不会一块用，我这儿是为了方便说明）

x0  = [];    %状态变量设置为空，表示没有状态变量，以我们上面的假设，
             %可改为x0=[0,0]（离散和连续的状态变量我们都是设置为0）
str = [];    %这个就不用说了，保留参数，置空[]就可以了，反正没什么用

ts  = [0 0]; %[0 0]表示连续系统（连续采样时间），
             %[0.5 0.1]则表示离散采样时间，从0.1秒开始每0.5秒采集一次，0.1表示采样偏置，0.5采样频率
             %[-1,0]继承S函数输入信号或父层模型的采样的采样时间
simStateCompliance = 'UnknownSimState';

function sys=mdlDerivatives(t,x,u)

sys = [];    %如果设置连续状态变量个数为0，此处只需sys=[];就可以。按我们上面讨论的模型，此处改成
             %sys=fc(t,x1,u)或者sys=A*x(1)+B*u
             %我们这儿x(1)是连续状态变量，x(2)是离散的，这儿只用到连续的，此时的输出sys就是微分

function sys=mdlUpdate(t,x,u)
sys = [];

function sys=mdlOutputs(t,x,u)

sys = [];    %sys = []表示没有输出，我们改为sys=fo(t,x,u)或sys=C*x+D*u, sys此时为输出y

function sys=mdlGetTimeOfNextVarHit(t,x,u)  %连续系统中 写sys=[];
                                            %这个函数主要是用于变步长的设置，
                                            %具体实现可以参考edit vsfunc
                                            %看vsfunc.m这个例子
sampleTime = 1;    %  Example, set the next hit to be one second later.
sys = t + sampleTime;

function sys=mdlTerminate(t,x,u)

sys = [];

% end mdlTerminate

4，s函数还可以带用户参数，下面给个例子，和simulink下的gain模块功能一样只不过是离散的采样时间。

代码如下：

function [sys,x0,str,ts,simStateCompliance] = gain(t,x,u,flag,gain)
switch flag,
  case 0,
    [sys,x0,str,ts,simStateCompliance]=mdlInitializeSizes;
  case 1,
    sys=mdlDerivatives(t,x,u);
  case 2,
    sys=mdlUpdate(t,x,u);
  case 3,
    sys=mdlOutputs(t,x,u,gain);
  case 4,
    sys=mdlGetTimeOfNextVarHit(t,x,u);
  case 9,
    sys=mdlTerminate(t,x,u);
  otherwise
    DAStudio.error('Simulink:blocks:unhandledFlag', num2str(flag));
end
function [sys,x0,str,ts,simStateCompliance]=mdlInitializeSizes
sizes = simsizes;
sizes.NumContStates  = 0;
sizes.NumDiscStates  = 0;
sizes.NumOutputs     = 1;
sizes.NumInputs      = 1;
sizes.DirFeedthrough = 1;
sizes.NumSampleTimes = 1; 
sys = simsizes(sizes);
x0  = [];
str = [];
ts  = [0.1 0]; %表示每0.1秒采样一次
simStateCompliance = 'UnknownSimState';
function sys=mdlDerivatives(t,x,u)
sys = [];
function sys=mdlUpdate(t,x,u)
sys = [];
function sys=mdlOutputs(t,x,u,gain)
sys =gain*u;
function sys=mdlGetTimeOfNextVarHit(t,x,u) %仅在系统是变采样时间系统时调用
sys=[];
function sys=mdlTerminate(t,x,u)
sys = [];

那么其中用户的参数哪里设置呢？

双击S-function模块及其对话框如下图所示

对上面的填入的参数进行下说明：

• S-function name: 填入S-function的函数名称，这样就建立了S-function模块与M文件形式的S-function之间的对应关系，单击后面的Edit可以打开S-function的M文件的编辑窗口。

• S-function parameters：填入的就是用户参数了，如果有多个变量的话，中间用逗号隔开，如a,b,c.

• S-function modules: 只有S-function是用C语言编写并用MEX工具编译的C MEX文件时，才需要填写该参数。

运行结果如下：