matlab simulink S-Function m文件的写法

原文章地址

     s函数是system Function的简称，用它来写自己的simulink模块。可以用matlab、C、C++、Fortran、Ada等语言来写，这儿我只介绍怎样用matlab语言来写吧（主要是它比较简单）。

        先讲讲为什么要用 s 函数，用 s 函数可以利用 matlab 的丰富资源 ，而用 c 或 c++ 等语言写的 s 函数还可以实现对硬件端口的操作， 还能操作windows的API 等。
       先介绍一下 simulink 的仿真过程（以便理解 s 函数）， simulink 的仿真有两个阶段：一个为初始化，这个阶段主要是设置一些参数，像系统的输入输出个数、状态初值、采样时间等；第二个阶段就是运行阶段，这个阶段里要进行计算输出、更新离散状态、更新连续状态等等，这个阶段需要反复运行，直至结束。

    在matlab的workspace里打edit sfuntmpl(这是matlab自己提供的s函数模板)，我们看它来具体分析s函数的结构。它的第一行是这样的：

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

     先讲输入与输出变量的含义：

     t：代表当前的仿真时间，这个输入参数通常用于决定下一个采样时刻，或者在多采样速率系统中，用来区分不同的采样时刻点，并据此进行不同的处理。
     x：表示状态向量，这个参数是必须的，甚至在系统中不存在状态时也是如此。它具有很灵活的运用。
     u：表示输入向量。（是做成simulink模块的输入）
     flag：是一个控制在每一个仿真阶段调用哪一个子函数的参数，由Simulink在调用时自动取值。
     sys：是一个通用的返回参数，它所返回值的意义取决于flag的值。
     x0：是初始的状态值（没有状态时是一个空矩阵[]），这个返回参数只在flag值为0时才有效，其他时候都会被忽略。

     str是保留参数（mathworks公司还没想好该怎么用它，一般在初始化中将它置空就可以了,str=[])。

     ts是一个1×2的向量，ts(1)是采样周期，ts(2)是偏移量。

     下面结合 sfuntmpl.m 中的代码来讲具体的结构：
     switch flag,                        % 判断 flag ，看当前处于哪个状态
     case 0,
         [sys,x0,str,ts]=mdlInitializeSizes;   %flag=0， 表示处于初始化状态，跑去调用函数 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输出

     如果字段代表的向量宽度为动态可变，则可以将它们赋值为－1。

     NumSampleTimes表示采样时间的个数，也就是ts变量的行数，与用户对ts的定义有关。

     需要指出的是，由于s-function会忽略端口，所以当有多个输入变量或多个输出变量时，必须用mux模块或demux模块将多个单一输入合成一个复合输入向量或将一个复合输出向量分解为多个单一输出。

     举个例子，考虑如下模型：
                         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;

     ts=1;
     其他的可以不变。继续在mdlInitializeSizes函数中往下看：
      x0 = [];     % 状态变量设置为空，表示没有状态变量，以我们上面的假设，为x0=[0,0](离散和连续的状态变量我们都设它初值为0)
      str = [];     % 这个就不用说了，保留参数嘛，置[]就可以了，反正没什么用
      ts = [0 0];   %ts(1)是采样周期，ts(2)是偏移量。 采样周期设为0表示是连续系统。

     在sfuntmpl继续往下看：
        case 1,
          sys=mdlDerivatives(t,x,u);
     flag=1 表示此时要计算 连续状态 的微分， 跑去调用函数mdlDerivatives，即上面提到的dx/dt=fc(t,x,u)中的dx/dt。找到mdlDerivatives函数如果设置连续状态变量个数为0，此处只需sys=[];就可以了；按我们上述讨论的那个模型，此处改成 sys=fc(t,x(1),u)或sys=A*x(1)+B*u；我们这儿x(1)是连续状态变量，而x(2)是离散的，这儿只用到连续的，此时的输出sys就是微分。不同的状态下，sys代表的意义不一样，该函数下sys代表微分。
     继续：
      case 2,
      sys=mdlUpdate(t,x,u);
     flag=2表示此时要计算下一个离散状态，跑去调用函数mdlUpdate，即上面提到的x(k+1)=fd(t,x,u)，找到mdlUpdate函数，模板文件这儿sys=[];表示没有离散状态，我们这而可以改成sys=fd(t,x(2),u)或sys=H*x(2)+G*u; %sys即为x(k+1）
看来后面几个一两句话就可了，呵呵，在 sfuntmpl 的 118 行
        case 3,
      sys=mdlOutputs(t,x,u);
     flag=3表示此时要计算输出，跑去调用函数mdlOutputs，即y=fo(t,x,u),找到mdlOutputs函数，如果sys=[]表示没有输出，我们改成sys=fo(t,x,u)或sys=C*x+D*u %sys此时为输出y
        case 4,
          sys=mdlGetTimeOfNextVarHit(t,x,u);
     flag=4 表示此时要计算下一次采样的时间，只在离散采样系统中有用 ( 即上文的初始化函数 mdlInitializeSizes 中提到的 ts 设置 ts(1) 不为 0)。
连续系统（ts(1)=0）中只需在 mdlGetTimeOfNextVarHit 函数中写上 sys=[]; 这个函数主要用于变步长的设置，具体实现大家可以用 edit vsfunc 看 vsfunc.m 这个例子
        case 9,
           sys=mdlTerminate(t,x,u);

     flag=9表示此时系统要结束，一般来说在mdlTerminate函数中写上sys=[]就可，如果你在结束时还要设置什么，就在此函数中码相关代码。

     关于sfuntmpl这个s函数的模板讲完了。

例子1

和simulink下的gain模块功能一样。注：s函数还可以带用户参数
function [sys,x0,str,ts] = sfungain(t,x,u,flag,gain)
switch flag,
case 0,
 

function [sys,x0,str,ts] = sfungain(t,x,u,flag,gain)
switch flag,
case 0,
          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,0];
case 3,
         sys=gain*u;
case {1,2,4,9},
          sys = [];
end

使用模板编写s-function，如果需要额外的输入参量，可以在输入参数列表的后面增加这些参数，因为前面的4个参数是simulink调用s-function时自动传入的。对于输出参数，最好不做修改。

例子2
dx1=x2
dx2=9.81*sin(x(1))-2*x(2)+u
求出系统在单位阶跃输入下的 x1 的状态变化曲线，假设 x1,x2 初值为 0 。
function [sys,x0]=dong(t,x,u,flag)
if flag==0
        sys=[2;0;2;1;0;0];
        x0=[0;0];
elseif flag==1
        sys=[x(2);9.81*sin(x(1))-2*x(2)+u];
elseif flag==3
        sys=[x(1);x(2)];
else
        sys=[];
end