3 * Copyright (C) INRIA - METALAU Project <scicos@inria.fr>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * See the file ./license.txt
22 #ifndef __SCICOS_BLOCK4_H__
23 #define __SCICOS_BLOCK4_H__
33 typedef void (*voidg) ();
35 typedef void (*voidg) (void);
38 /* scicos_block structure definition
39 * WARNING: take care that this sructure is
40 * not the same as the one in scicos_block.h
41 * i.e same name but inptr and outptr are void **
86 /** define scicos flag number */
89 /* Should not be used directly, set through the API. */
92 /* Valid simulation states */
96 OutputEventTiming = 3,
100 ContinousPropertiesUpdate = 7,
105 /* utility function for block declaration */
106 int get_block_error(void);
107 int *get_pointer_xproperty(void);
108 int get_npointer_xproperty(void);
109 double Get_Jacobian_cj(void);
110 double Get_Jacobian_ci(void);
111 double Get_Scicos_SQUR(void);
112 void Set_Jacobian_flag(int flag);
114 int Convert_number(char *, double *);
115 void homotopy(double *);
116 int hfjac_(double *, double *, int *);
117 int rhojac_(double *, double *, double *, double *, int *, double *, int *);
118 int rho_(double *, double *, double *, double *, double *, int *);
119 int fx_(double *, double *);
120 int read_xml_initial_states(int nvar, const char *xmlfile, char **ids, double *svars);
121 int write_xml_states(int, const char *, char **, double *);
123 /** Define scicos simulator data type number (_N) */
137 } scicos_datatype_number;
139 /* Define scicos simulator data type C operators (_COP) */
140 #define SCSREAL_COP double
141 #define SCSCOMPLEX_COP double
142 #define SCSINT_COP int
143 #define SCSINT8_COP char
144 #define SCSINT16_COP short
145 #define SCSINT32_COP long
146 #define SCSUINT_COP unsigned int
147 #define SCSUINT8_COP unsigned char
148 #define SCSUINT16_COP unsigned short
149 #define SCSUINT32_COP unsigned long
150 #define SCSUNKNOW_COP double
152 /* scicos_block macros definition :
155 * 2 - GetInPortPtrs(blk,x)
157 * 4 - GetOutPortPtrs(blk,x)
158 * 5 - GetInPortRows(blk,x)
159 * 6 - GetInPortCols(blk,x)
160 * 7 - GetInPortSize(blk,x,y)
161 * 8 - GetInType(blk,x)
162 * 9 - GetOutPortRows(blk,x)
163 * 10 - GetOutPortCols(blk,x)
164 * 11 - GetOutPortSize(blk,x,y)
165 * 12 - GetOutType(blk,x)
166 * 13 - GetRealInPortPtrs(blk,x)
167 * 14 - GetImagInPortPtrs(blk,x)
168 * 15 - GetRealOutPortPtrs(blk,x)
169 * 16 - GetImagOutPortPtrs(blk,x)
170 * 17 - Getint8InPortPtrs(blk,x)
171 * 18 - Getint16InPortPtrs(blk,x)
172 * 19 - Getint32InPortPtrs(blk,x)
173 * 20 - Getuint8InPortPtrs(blk,x)
174 * 21 - Getuint16InPortPtrs(blk,x)
175 * 22 - Getuint32InPortPtrs(blk,x)
176 * 23 - Getint8OutPortPtrs(blk,x)
177 * 24 - Getint16OutPortPtrs(blk,x)
178 * 25 - Getint32OutPortPtrs(blk,x)
179 * 26 - Getuint8OutPortPtrs(blk,x)
180 * 27 - Getuint16OutPortPtrs(blk,x)
181 * 28 - Getuint32OutPortPtrs(blk,x)
184 * 31 - GetIparPtrs(blk)
186 * 33 - GetRparPtrs(blk)
188 * 34 - GetWorkPtrs(blk)
189 * 35 - GetNstate(blk)
191 * 37 - GetDerState(blk))
192 * 38 - GetResState(blk)
193 * 39 - GetXpropPtrs(blk)
195 * 40 - GetNdstate(blk)
196 * 41 - GetDstate(blk)
199 * 43 - GetNevOut(blk)
200 * 44 - GetNevOutPtrs(blk)
203 * 46 - GetOparType(blk,x)
204 * 47 - GetOparSize(blk,x,y)
205 * 48 - GetOparPtrs(blk,x)
206 * 49 - GetRealOparPtrs(blk,x)
207 * 50 - GetImagOparPtrs(blk,x)
208 * 51 - Getint8OparPtrs(blk,x)
209 * 52 - Getint16OparPtrs(blk,x)
210 * 53 - Getint32OparPtrs(blk,x)
211 * 54 - Getuint8OparPtrs(blk,x)
212 * 55 - Getuint16OparPtrs(blk,x)
213 * 56 - Getuint32OparPtrs(blk,x)
215 * 58 - GetOzType(blk,x)
216 * 59 - GetOzSize(blk,x,y)
217 * 60 - GetOzPtrs(blk,x)
218 * 61 - GetRealOzPtrs(blk,x)
219 * 62 - GetImagOzPtrs(blk,x)
220 * 63 - Getint8OzPtrs(blk,x)
221 * 64 - Getint16OzPtrs(blk,x)
222 * 65 - Getint32OzPtrs(blk,x)
223 * 66 - Getuint8OzPtrs(blk,x)
224 * 67 - Getuint16OzPtrs(blk,x)
225 * 68 - Getuint32OzPtrs(blk,x)
226 * 69 - GetSizeOfOz(blk,x)
227 * 70 - GetSizeOfOpar(blk,x)
228 * 71 - GetSizeOfOut(blk,x)
229 * 72 - GetSizeOfIn(blk,x)
233 * 75 - GetJrootPtrs(blk)
235 * 77 - GetModePtrs(blk)
236 * 78 - GetLabelPtrs(blk)
240 \brief Get number of regular input port.
242 #define GetNin(blk) (blk->nin)
245 \brief Get regular input port pointer of port number x.
247 #define GetInPortPtrs(blk,x) ((((x)>0)&((x)<=(blk->nin))) ? (blk->inptr[x-1]) : NULL)
250 \brief Get number of regular output port.
252 #define GetNout(blk) (blk->nout)
255 \brief Get regular output port pointer of port number x.
257 #define GetOutPortPtrs(blk,x) ((((x)>0)&((x)<=(blk->nout))) ? (blk->outptr[x-1]) : NULL)
260 \brief Get number of rows (first dimension) of regular input port number x.
262 #define GetInPortRows(blk,x) ((((x)>0)&((x)<=(blk->nin))) ? (blk->insz[x-1]) : 0)
265 \brief Get number of columns (second dimension) of regular input port number x.
267 #define GetInPortCols(blk,x) ((((x)>0)&((x)<=(blk->nin))) ? (blk->insz[blk->nin+(x-1)]) : 0)
270 \brief Get regular input port size number x.
273 * GetInPortSize(blk,x,1) : get first dimension of input port number x
274 * GetInPortSize(blk,x,2) : get second dimension of input port number x
276 #define GetInPortSize(blk,x,y) ((((x)>0)&((x)<=(blk->nin))) ? \
277 ((((y)>0)&((y)<=2)) ? (blk->insz[(y-1)*blk->nin+(x-1)]) : 0) : 0)
280 \brief Get type of regular input port number x.
282 #define GetInType(blk,x) ((((x)>0)&((x)<=(blk->nin))) ? \
283 (blk->insz[2*(blk->nin)+(x-1)]) : 0)
286 \brief Get number of rows (first dimension) of regular output port number x.
288 #define GetOutPortRows(blk,x) ((((x)>0)&((x)<=(blk->nout))) ? (blk->outsz[x-1]) : 0)
291 \brief Get number of columns (second dimension) of regular output port number x.
293 #define GetOutPortCols(blk,x) ((((x)>0)&((x)<=(blk->nout))) ? (blk->outsz[blk->nout+(x-1)]) : 0)
296 \brief Get regular output port size number x.
299 * GetOutPortSize(blk,x,1) : get first dimension of output port number x
300 * GetOutPortSize(blk,x,2) : get second dimension of output port number x
302 #define GetOutPortSize(blk,x,y) ((((x)>0)&((x)<=(blk->nout))) ? \
303 ((((y)>0)&((y)<=2)) ? (blk->outsz[(y-1)*blk->nout+(x-1)]) : 0) : 0)
306 \brief Get type of regular output port number x.
308 #define GetOutType(blk,x) ((((x)>0)&((x)<=(blk->nout))) ? \
309 (blk->outsz[2*(blk->nout)+(x-1)]) : 0)
312 \brief Get pointer of real part of regular input port number x.
314 #define GetRealInPortPtrs(blk,x) (SCSREAL_COP *) GetInPortPtrs(blk,x)
317 \brief Get pointer of imaginary part of regular input port number x.
319 #define GetImagInPortPtrs(blk,x) (((x)>0)&((x)<=(blk->nin)) ? \
320 (SCSREAL_COP *) ((SCSREAL_COP *)blk->inptr[x-1]+ \
321 ((blk->insz[(x-1)])*(blk->insz[blk->nin+(x-1)]))) : NULL)
324 \brief Get pointer of real part of regular output port number x.
326 #define GetRealOutPortPtrs(blk,x) (SCSREAL_COP *) GetOutPortPtrs(blk,x)
329 \brief Get pointer of imaginary part of regular output port number x.
331 #define GetImagOutPortPtrs(blk,x) (((x)>0)&((x)<=(blk->nout)) ? \
332 (SCSREAL_COP *) ((SCSREAL_COP *)blk->outptr[x-1]+ \
333 ((blk->outsz[(x-1)])*(blk->outsz[blk->nout+(x-1)]))) : NULL)
336 \brief Get pointer of int8 typed regular input port number x.
338 #define Getint8InPortPtrs(blk,x) (SCSINT8_COP *) GetInPortPtrs(blk,x)
341 \brief Get pointer of int16 typed regular input port number x.
343 #define Getint16InPortPtrs(blk,x) (SCSINT16_COP *) GetInPortPtrs(blk,x)
346 \brief Get pointer of int32 typed regular input port number x.
348 #define Getint32InPortPtrs(blk,x) (SCSINT32_COP *) GetInPortPtrs(blk,x)
351 \brief Get pointer of uint8 typed regular input port number x.
353 #define Getuint8InPortPtrs(blk,x) (SCSUINT8_COP *) GetInPortPtrs(blk,x)
356 \brief Get pointer of uint16 typed regular input port number x.
358 #define Getuint16InPortPtrs(blk,x) (SCSUINT16_COP *) GetInPortPtrs(blk,x)
361 \brief Get pointer of uint32 typed regular input port number x.
363 #define Getuint32InPortPtrs(blk,x) (SCSUINT32_COP *) GetInPortPtrs(blk,x)
366 \brief Get pointer of int8 typed regular output port number x.
368 #define Getint8OutPortPtrs(blk,x) (SCSINT8_COP *) GetOutPortPtrs(blk,x)
371 \brief Get pointer of int16 typed regular output port number x.
373 #define Getint16OutPortPtrs(blk,x) (SCSINT16_COP *) GetOutPortPtrs(blk,x)
376 \brief Get pointer of int32 typed regular output port number x.
378 #define Getint32OutPortPtrs(blk,x) (SCSINT32_COP *) GetOutPortPtrs(blk,x)
381 \brief Get pointer of uint8 typed regular output port number x.
383 #define Getuint8OutPortPtrs(blk,x) (SCSUINT8_COP *) GetOutPortPtrs(blk,x)
386 \brief Get pointer of uint16 typed regular output port number x.
388 #define Getuint16OutPortPtrs(blk,x) (SCSUINT16_COP *) GetOutPortPtrs(blk,x)
391 \brief Get pointer of uint32 typed regular output port number x.
393 #define Getuint32OutPortPtrs(blk,x) (SCSUINT32_COP *) GetOutPortPtrs(blk,x)
396 \brief Get number of integer parameters.
398 #define GetNipar(blk) (blk->nipar)
401 \brief Get pointer of the integer parameters register
403 #define GetIparPtrs(blk) (blk->ipar)
406 \brief Get number of real parameters.
408 #define GetNrpar(blk) (blk->nrpar)
411 \brief Get pointer of the real parameters register.
413 #define GetRparPtrs(blk) (blk->rpar)
416 \brief Get the pointer of the Work array.
418 #define GetWorkPtrs(blk) (*(blk->work))
421 \brief Get number of continuous state.
423 #define GetNstate(blk) (blk->nx)
426 \brief Get pointer of the continuous state register.
428 #define GetState(blk) (blk->x)
431 \brief Get pointer of the derivative continuous state register.
433 #define GetDerState(blk) (blk->xd)
436 \brief Get pointer of the residual continuous state register.
438 #define GetResState(blk) (blk->res)
441 \brief Get pointer of continuous state properties register.
443 #define GetXpropPtrs(blk) (blk->xprop)
446 \brief Get number of discrete state.
448 #define GetNdstate(blk) (blk->nz)
451 \brief Get pointer of the discrete state register.
453 #define GetDstate(blk) (blk->z)
456 \brief Get the input event number.
458 #define GetNevIn(blk) (blk->nevprt)
461 \brief Get number of event output port.
463 #define GetNevOut(blk) (blk->nevout)
466 \brief Get pointer of event output register.
468 #define GetNevOutPtrs(blk) (blk->evout)
471 \brief Get number of object parameters.
473 #define GetNopar(blk) (blk->nopar)
476 \brief Get type of object parameters number x.
478 #define GetOparType(blk,x) (((x>0)&(x<=blk->nopar)) ? (blk->opartyp[x-1]) : 0)
481 \brief Get size of object parameters number x.
485 * GetOparSize(blk,x,1) : get first dimension of opar
486 * GetOparSize(blk,x,2) : get second dimension of opar
488 #define GetOparSize(blk,x,y) (((x>0)&(x<=blk->nopar)) ? \
489 ((((y)>0)&((y)<=2)) ? (blk->oparsz[(y-1)*blk->nopar+(x-1)]) : 0) : 0)
492 \brief Get pointer of object parameters number x.
494 #define GetOparPtrs(blk,x) (((x>0)&(x<=blk->nopar)) ? (blk->oparptr[x-1]) : 0)
497 \brief Get pointer of real object parameters number x.
499 #define GetRealOparPtrs(blk,x) (SCSREAL_COP *) GetOparPtrs(blk,x)
502 \brief Get pointer of imaginary part of object parameters number x.
504 #define GetImagOparPtrs(blk,x) (((x)>0)&((x)<=(blk->nopar)) ? \
505 (SCSREAL_COP *) ((SCSREAL_COP *)blk->oparptr[x-1]+ \
506 ((blk->oparsz[x-1])*(blk->oparsz[blk->nopar+(x-1)]))) : NULL)
509 \brief Get pointer of int8 typed object parameters number x.
511 #define Getint8OparPtrs(blk,x) (SCSINT8_COP *) GetOparPtrs(blk,x)
514 \brief Get pointer of int16 typed object parameters number x.
516 #define Getint16OparPtrs(blk,x) (SCSINT16_COP *) GetOparPtrs(blk,x)
519 \brief Get pointer of int32 typed object parameters number x.
521 #define Getint32OparPtrs(blk,x) (SCSINT32_COP *) GetOparPtrs(blk,x)
524 \brief Get pointer of uint8 typed object parameters number x.
526 #define Getuint8OparPtrs(blk,x) (SCSUINT8_COP *) GetOparPtrs(blk,x)
529 \brief Get pointer of uint16 typed object parameters number x.
531 #define Getuint16OparPtrs(blk,x) (SCSUINT16_COP *) GetOparPtrs(blk,x)
534 \brief Get pointer of uint32 typed object parameters number x.
536 #define Getuint32OparPtrs(blk,x) (SCSUINT32_COP *) GetOparPtrs(blk,x)
539 \brief Get number of object state.
541 #define GetNoz(blk) (blk->noz)
544 \brief Get type of object state number x.
546 #define GetOzType(blk,x) (((x>0)&(x<=blk->noz)) ? (blk->oztyp[x-1]) : 0)
549 \brief Get size of object state number x.
553 * GetOzSize(blk,x,1) : get first dimension of oz
554 * GetOzSize(blk,x,2) : get second dimension of oz
556 #define GetOzSize(blk,x,y) (((x>0)&(x<=blk->noz)) ? \
557 ((((y)>0)&((y)<=2)) ? (blk->ozsz[(y-1)*blk->noz+(x-1)]) : 0) : 0)
560 \brief Get pointer of object state number x.
562 #define GetOzPtrs(blk,x) (((x>0)&(x<=blk->noz)) ? (blk->ozptr[x-1]) : 0)
565 \brief Get pointer of real object state number x.
567 #define GetRealOzPtrs(blk,x) (SCSREAL_COP *) GetOzPtrs(blk,x)
570 \brief Get pointer of imaginary part of object state number x.
572 #define GetImagOzPtrs(blk,x) (((x)>0)&((x)<=(blk->noz)) ? \
573 (SCSREAL_COP *) ((SCSREAL_COP *)blk->ozptr[x-1]+ \
574 ((blk->ozsz[x-1])*(blk->ozsz[blk->noz+(x-1)]))) : NULL)
577 \brief Get pointer of int8 typed object state number x.
579 #define Getint8OzPtrs(blk,x) (SCSINT8_COP *) GetOzPtrs(blk,x)
582 \brief Get pointer of int16 typed object state number x.
584 #define Getint16OzPtrs(blk,x) (SCSINT16_COP *) GetOzPtrs(blk,x)
587 \brief Get pointer of int32 typed object state number x.
589 #define Getint32OzPtrs(blk,x) (SCSINT32_COP *) GetOzPtrs(blk,x)
592 \brief Get pointer of uint8 typed object state number x.
594 #define Getuint8OzPtrs(blk,x) (SCSUINT8_COP *) GetOzPtrs(blk,x)
597 \brief Get pointer of uint16 typed object state number x.
599 #define Getuint16OzPtrs(blk,x) (SCSUINT16_COP *) GetOzPtrs(blk,x)
602 \brief Get pointer of uint32 typed object state number x.
604 #define Getuint32OzPtrs(blk,x) (SCSUINT32_COP *) GetOzPtrs(blk,x)
607 \brief Get the sizeof of the object state number x.
609 #define GetSizeOfOz(blk,x) ((GetOzType(blk,x)==SCSREAL_N) ? (sizeof(SCSREAL_COP)) : \
610 (GetOzType(blk,x)==SCSCOMPLEX_N) ? (2*sizeof(SCSCOMPLEX_COP)) : \
611 ((GetOzType(blk,x)==SCSINT8_N)|(GetOzType(blk,x)==SCSUINT8_N)) ? (sizeof(SCSINT8_COP)) : \
612 ((GetOzType(blk,x)==SCSINT16_N)|(GetOzType(blk,x)==SCSUINT16_N)) ? (sizeof(SCSINT16_COP)) : \
613 ((GetOzType(blk,x)==SCSINT32_N)|(GetOzType(blk,x)==SCSUINT32_N)) ? (sizeof(SCSINT32_COP)) : 0)
616 \brief Get the sizeof of the object parameters number x.
618 #define GetSizeOfOpar(blk,x) ((GetOparType(blk,x)==SCSREAL_N) ? (sizeof(SCSREAL_COP)) : \
619 (GetOparType(blk,x)==SCSCOMPLEX_N) ? (2*sizeof(SCSCOMPLEX_COP)) : \
620 ((GetOparType(blk,x)==SCSINT8_N)|(GetOparType(blk,x)==SCSUINT8_N)) ? (sizeof(SCSINT8_COP)) : \
621 ((GetOparType(blk,x)==SCSINT16_N)|(GetOparType(blk,x)==SCSUINT16_N)) ? (sizeof(SCSINT16_COP)) : \
622 ((GetOparType(blk,x)==SCSINT32_N)|(GetOparType(blk,x)==SCSUINT32_N)) ? (sizeof(SCSINT32_COP)) : 0)
625 \brief Get the sizeof of the regular output port number x.
627 #define GetSizeOfOut(blk,x) ((GetOutType(blk,x)==SCSREAL_N) ? (sizeof(SCSREAL_COP)) : \
628 (GetOutType(blk,x)==SCSCOMPLEX_N) ? (2*sizeof(SCSCOMPLEX_COP)) : \
629 ((GetOutType(blk,x)==SCSINT8_N)|(GetOutType(blk,x)==SCSUINT8_N)) ? (sizeof(SCSINT8_COP)) : \
630 ((GetOutType(blk,x)==SCSINT16_N)|(GetOutType(blk,x)==SCSUINT16_N)) ? (sizeof(SCSINT16_COP)) : \
631 ((GetOutType(blk,x)==SCSINT32_N)|(GetOutType(blk,x)==SCSUINT32_N)) ? (sizeof(SCSINT32_COP)) : 0)
633 \brief Get the sizeof of the regular input port number x.
635 #define GetSizeOfIn(blk,x) ((GetInType(blk,x)==SCSREAL_N) ? (sizeof(SCSREAL_COP)) : \
636 (GetInType(blk,x)==SCSCOMPLEX_N) ? (2*sizeof(SCSCOMPLEX_COP)) : \
637 ((GetInType(blk,x)==SCSINT8_N)|(GetInType(blk,x)==SCSUINT8_N)) ? (sizeof(SCSINT8_COP)) : \
638 ((GetInType(blk,x)==SCSINT16_N)|(GetInType(blk,x)==SCSUINT16_N)) ? (sizeof(SCSINT16_COP)) : \
639 ((GetInType(blk,x)==SCSINT32_N)|(GetInType(blk,x)==SCSUINT32_N)) ? (sizeof(SCSINT32_COP)) : 0)
642 \brief Get number of zero crossing surface.
644 #define GetNg(blk) (blk->ng)
647 \brief Get pointer of the zero crossing register.
649 #define GetGPtrs(blk) (blk->g)
652 \brief Get pointer of the direction of the zero crossing register.
654 #define GetJrootPtrs(blk) (blk->jroot)
657 \brief Get number of modes.
659 #define GetNmode(blk) (blk->nmode)
662 \brief Get pointer of the mode register.
664 #define GetModePtrs(blk) (blk->mode)
667 \brief Get pointer of the block label
669 #define GetLabelPtrs(blk) (blk->label)
671 #endif /* __SCICOS_BLOCK_H__ */