addloself(3alc)

1ADDLOSELF(3)                 MBK LOGICAL FUNCTIONS                ADDLOSELF(3)
2
3
4

NAME

6       addloself - create a logical inductor
7

SYNOPSIS

9       #include "mlo.h"
10
11       loself_list ∗addloself(ptfig,type,self,scon1,scon2,name)
12       lofig_list ∗ptfig ;
13       char type ;
14       double self ;
15       losig_list ∗scon1, ∗scon2 ;
16       const char ∗name ;
17

PARAMETERS

19       ptfig               Pointer  to the figure in which the inductor should
20                           be added
21
22       type                Inductor type
23
24       self                Inductor value in Henry
25
26       scon1               Pointer to the signal to be connected on the induc‐
27                           tor top plate
28
29       scon2               Pointer to the signal to be connected on the induc‐
30                           tor bottom plate
31
32       name                Inductor instance name
33

DESCRIPTION

35       addloself creates a new inductor, and adds it to the list of  inductors
36       pointed  to  by  ptfig -> LOSELF. The new inductor is added in front of
37       the list, and becomes itself the list head.
38       The type parameter can take one value :
39
40              SELFMIM             for a metal inductor
41
42       The self argument is the inductor value in Henry.
43       Two connectors are created each time a inductor is added, and the scon1
44       and  scon2  losigs  are  attached  to the SIG field of the locon of the
45       appropriate connector. The connectors names are scon1  and scon2; their
46       direction,  DIR,  are set to 'L', and their TYPE INTERNAL.  For details
47       on the structuself, see locon(3) and loself(3).
48

RETURN VALUE

50       addloself returns a pointer to the newly created inductor.
51

ERRORS

53       "∗∗∗ mbk error ∗∗∗ illegal inductor type : type"
54              The type is not a legal inductor type.
55

EXAMPLE

57       #include "mlo.h"
58
59       void parallel_inductors(void) /∗ netlist of two parallel inductors ∗/
60       {
61         lofig_list ∗pt  = NULL ;
62         losig_list ∗in  = NULL ;
63         losig_list ∗out = NULL ;
64
65         pt = addlofig("parallel_inductors") ;
66         addlocon(pt,"in",in = givelosig(pt,0),IN) ;
67         addlocon(pt,"out",out = givelosig(pt,1),OUT) ;
68
69         addloself(pt,SELFMIM,0.6e-6,in,out,"self1") ;
70         addloself(pt,SELFMIM,0.6e-6,in,out,"self2") ;
71       }
72