matlab中的S函数

S函数的简介及编写
摘自恒润科技S-function的编写
1. S函数模板编辑环境进入：
在MATLAB主界面中直接输入：edit sfuntmpl
即可弹出S函数模板编辑的M文件环境，修改即可。

在MATLAB主界面中直接输入：sfundemos，即可调出S 函数的许多编程例子。

2. S函数模板的相关基础：
1)M文件S函数的引导语句为：
x
t
flag
f
u
Function
[p
sys
x
str
ts
p
,
,1
2
,...)
,
,
,0
,
]
,(
,
S函数默认的四个输入参数：t ,x ,u ,flag
S函数默认的四个输出函数：sys ,x0 ,str ,ts
各个参数的含义如下：
T ：代表当前的仿真时间，该输入决定了下一个采样时间；
X ：表示状态向量，行向量，引用格式：X(1),X(2)
U ：表示输入向量;
Flag ：控制在每一个仿真阶段调用哪一个子函数的参数，由SIMULINK在调用时自动取值；
Sys ：通用的返回变量，返回的数值决定Flag值，mdlUpdates里：列向量，引用格式：Sys(1,1),Sys(2,1)；mdlOutputs里：行向量，引用格式：Sys =x.
X0 ：初始的状态值；列向量，引用格式：X0=[ 0；0；0 ]
Str ：空矩阵，无具体含义；
Ts ：包含模块采样时间和偏差的矩阵。

[period, offset]
当Ts为-1时，表示与输入信号同采样周期。

2)S函数工作方式：
Flag = 0时，调用mdlInitializeSizes函数，定义S函数的基本特性，包括采样时间，连续或者离散状态的初始条件和Sizes数组；
Flag = 1时，调用mdlDerivatives函数，计算连续状态变量的微分方程；求所给表达式的等号左边状态变量的积分值的过程。

Flag = 2时，调用mdlUpdate函数，用于更新离散状态，采样时间和主时间步的要求；
Flag = 3时，调用mdlOutputs函数，计算S函数的输出；
Flag = 4时，调用mdlGetTimeOfNextVarHit函数，计算下一个采样点的绝对时间，这个方法仅仅是使用户在mdlInitializeSize 里说明一个可变的离散采样时间；
Flag = 9时，调用mdlTerminate函数，实现仿真任务的结束。

3)S函数仿真过程：
①初始化：mdlInitializeSizes，初始化S函数
●初始化SimStruct，包含了S函数的所有信息；
●设置输入、输出端口数；
●设置采样时间；
●分配存储空间。

②数值积分：mdlDerivatives
●用于连续状态的求解和非采样过零点；
●如果存在连续状态，调用mdlDerivatives和mdlOutput两个子函
数；
●如果存在非采样过零点，调用mdlOutput和mdlZeroCrossings子
函数，以定位过零点。

③更新离散状态：mdlUpdate
④计算输出：mdlOutputs，计算所有输出端口的输出值。

⑤计算下一个采样时间点：mdlGetTimeOfNextVarHit
⑥仿真结束：mdlTerminate，在仿真结束时调用。

3. S函数的编写：
1)参数初始设定：初始化sizes结构，再调用simsizes函数；
Sizes结构体：
NumContStates：连续状态的个数
NumDiscStates：离散状态的个数
NumOutputs：输出变量的个数
NumInputs：输入变量的个数
DirFeedthrough：有无直接馈入，值为1时表示输入直接传到输出口
NumSampleTimes：采样时间的个数，值为1时表示只有一个采样周期
Simsizes函数的调用：sys = simsizes (sizes) ,即将sizes结构体中的信息传递给sys。

2)状态的动态更新：
连续模块的状态更新由mdlDerivatives函数来进行；
离散模块的状态更新由mdlUpdate函数来进行；
3)输出信号的计算：
计算出模块的输出信号，系统的输出仍然由sys变量返回。

4. M文件S函数的模块化：
在动态系统仿真设计，分析中，用户可以使用S-Function模块来调用S-函数。

1)S-Function模块是一个单输入单输出的模块，如果有多个输入与输出信号，
可以使用Mux模块与Demux模块对信号进行组合和分离操作；
2)在S-Function模块的参数设置对话框中，包含了调用的S函数名和用户输入
的参数列表，如下图所示：
3)S-Function模块是以图形的方式提供给用户一个调用S函数的接口，S函数
中的源文件必须由用户自行编写；
4)S-Function模块中的S-函数名和参数值列表必须与用户填写的S函数源文件
的名称和参数列表完全一致，包括参数的顺序。

5. S-Function模块建立流程：
6、m-file模版编写
附：
创建一个有1输入（2维），2输出（1维），3个参数，还有全局变量的s-function。

1.新建sfunction的C语言文件
打开simulink，点击User-Defined Functions里面的S-Function Examples。

这个里面有多个语言版本的模板，有C，C++，Ada，Fortran和M语言的版本，其实都小异，只要了解几个函数就很容易使用了。

选择C语言的版本：从S-function模块中选择C-file S-functions里面的Basic C-MEX template。

打开后，另存为自己的模块名字，如test.c。

下面我们来分析代码：
#define S_FUNCTION_NAME test//这里把文件名sfuntmpl_basic修改为test
#define S_FUNCTION_LEVEL 2
#include "simstruc.h"
//程序里面要用到的头文件在这里引用，如“math.h”等。

float global_var; //定义全局变量
static void mdlInitializeSizes(SimStruct *S)
{
//这个函数用来设置输入、输出和参数的。

ssSetNumSFcnParams(S, 3); /*设置参数个数，这里为3 */
if (ssGetNumSFcnParams(S) != ssGetSFcnParamsCount(S)) {
return;
}
ssSetNumContStates(S, 0);//设置连续状态的个数，缺省为0；
ssSetNumDiscStates(S, 0);//设置离散状态的个数，缺省为0；
if (!ssSetNumInputPorts(S, 1)) return;//设置输入变量的个数，这里为1
ssSetInputPortWidth(S, 0, 2); //设置输入变量0的维数为2
ssSetInputPortRequiredContiguous(S, 0, true); //设置input0的访问方式，true就是临近访问，这样指针的增量后就可以直接访问下个input端口了。

ssSetInputPortDirectFeedThrough(S, 0, 1);// 设置输入端口的信号是否mdlOutputs 函数中使用，这儿设置为true。

if (!ssSetNumOutputPorts(S, 2)) return;//设置输出变量的个数ssSetOutputPortWidth(S, 0, 1);//设置输出变量0的维数为1维
ssSetOutputPortWidth(S, 1, 1);//设置输出变量1的维数为1维ssSetNumSampleTimes(S, 1); //设置采样时间，此处为1s。

ssSetNumRWork(S, 0);//不管
ssSetNumIWork(S, 0);
ssSetNumPWork(S, 0);
ssSetNumModes(S, 0);
ssSetNumNonsampledZCs(S, 0);
ssSetOptions(S, 0);
//下面可以写全局变量的初始化程序
global_var=1;
}
static void mdlInitializeSampleTimes(SimStruct *S)//暂时不管
{
ssSetSampleTime(S, 0, CONTINUOUS_SAMPLE_TIME);
ssSetOffsetTime(S, 0, 0.0);
}
#define MDL_INITIALIZE_CONDITIONS /* Change to #undef to remove function */
#if defined(MDL_INITIALIZE_CONDITIONS)
static void mdlInitializeConditions(SimStruct *S)//暂时不管
{
}
#endif /* MDL_INITIALIZE_CONDITIONS */
#define MDL_START /* Change to #undef to remove function */
#if defined(MDL_START)
static void mdlStart(SimStruct *S)//暂时不管
{
}
#endif /* MDL_START */
static void mdlOutputs(SimStruct *S, int_T tid)//这里填入相关的运算、算法等{
real_T *para1 = mxGetPr(ssGetSFcnParam(S,0));
real_T *para2 = mxGetPr(ssGetSFcnParam(S,1));
real_T *para3 = mxGetPr(ssGetSFcnParam(S,2));
const real_T *u = (const real_T*) ssGetInputPortSignal(S,0);
real_T *y1 = ssGetOutputPortSignal(S,0);
real_T *y2 = ssGetOutputPortSignal(S,1);
y1[0]=u[0]*para1[0]+u[1]*para2[0];
y2[0]=u[1]*para3[0]+u[0]*para1[0];
}
#define MDL_UPDATE /* Change to #undef to remove function */
#if defined(MDL_UPDATE)
static void mdlUpdate(SimStruct *S, int_T tid)
{
}
#endif /* MDL_UPDATE */
#define MDL_DERIV ATIVES /* Change to #undef to remove function */
#if defined(MDL_DERIV ATIVES)
static void mdlDerivatives(SimStruct *S)
{
}
#endif /* MDL_DERIV ATIVES */
static void mdlTerminate(SimStruct *S)//这里需要把global变量全部初始化，否则下次运行程序时，全局变量还是之前的值。

{
}
#ifdef MATLAB_MEX_FILE /* Is this file being compiled as a MEX-file? */ #include "simulink.c" /* MEX-file interface mechanism */
#else
#include "cg_sfun.h" /* Code generation registration function */
#endif
2.编译
在matlab的command window 里面输入“mex test.c”，即可将test.c编译为mex 文件。

3.调用sfunction
在simulink空间里面拉入sfunction，在s-function name里面填入test，参数里面填入要设定的参数，然后仿真即可。