# doc-cache created by Octave 5.2.0
# name: cache
# type: cell
# rows: 3
# columns: 6
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 21
AddHyperLynxComponent


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 694
 function CSX = AddHyperLynxComponent(CSX, name, prio, port1, port2, varargin)

 Add a resistor, capacitor or inductance to a CSX model imported from HyperLynx.
 Component layout is limited to x or y direction, and top or bottom layers of pcb.
 
 arguments:
   name:       component name.
   prio:       component priority.
   port1:      component pad name. 
   port2:      component pad name. 
 
 optional arguments:
   'R', 'C', 'L':  definition of the lumped element properties

 examples:
 50R resistor between pads R1.1 and R1.2 with 1pF parasitic capacitance:
 CSX = AddHyperLynxComponent( CSX, 'R1', 'R1.1', 'R1.2', 'R', 50, 'C', 1e-12 );

 See also GetHyperLynxPort, AddLumpedElement




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 78
 function CSX = AddHyperLynxComponent(CSX, name, prio, port1, port2, varargin)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 22
AddHyperLynxDielectric


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 319
 function CSX = AddHyperLynxDielectric(CSX, name, epsilon, loss_tangent)

 Add a dielectric to a CSX model imported from HyperLynx.
 
 arguments:
   name:         material name.
   epsilon:      relative electric permittivity
   loss_tangent: loss tangent
 
 See also AddMaterial, AddDebyeMaterial, AddLorentzMaterial




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 72
 function CSX = AddHyperLynxDielectric(CSX, name, epsilon, loss_tangent)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
AddHyperLynxMetal2D


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 347
 function CSX = AddHyperLynxMetal2D(CSX, name, resistivity, thickness)

 Add a metal as a 2D conducting sheet to a CSX model imported from HyperLynx.
 
 arguments:
   name:         material name.
   resistivity:  metal resistivity
   thickness:    thickness of the metal layer, in m.
 
 See also AddMaterial, AddDebyeMaterial, AddLorentzMaterial




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 70
 function CSX = AddHyperLynxMetal2D(CSX, name, resistivity, thickness)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
AddHyperLynxMetal3D


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 337
 function CSX = AddHyperLynxMetal3D(CSX, name, resistivity, thickness)

 Add a metal as a 3D object to a CSX model imported from HyperLynx.
 
 arguments:
   name:         material name.
   resistivity:  metal resistivity
   thickness:    thickness of the metal layer, in m.
 
 See also AddMaterial, AddDebyeMaterial, AddLorentzMaterial




# name: <cell-element>
# type: sq_string
# elements: 1
# length: 70
 function CSX = AddHyperLynxMetal3D(CSX, name, resistivity, thickness)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 16
GetHyperLynxPort


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 469
 [side, start, stop, centre ] = GetHyperLynxPort(CSX, port_ref)
 Obtain coordinates of HyperLynx pin or pad.

 CSX:          CSX-object created by ImportHyperLynx()
 port_ref:     port reference from HyperLynx file.
 If an invalid port reference is given, all valid port references are printed.

 side:         board side, 'top', 'bottom' or ''.
 start:        3D port start coordinates
 stop:         3D port stop coordinates
 centre:       3D port centre coordinates



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
 [side, start, stop, centre ] = GetHyperLynxPort(CSX, port_ref)
 Obtain coord...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 15
ImportHyperLynx


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2344
 CSX = ImportHyperLynx(CSX, filename, varargin)
 load Hyperlynx file 'filename' into CSX .

 Other optional arguments:
 epsilonr       float.  Set dielectric epsilon r. Overrides value in Hyperlynx file.
 net            string. Import net. Repeat to import several nets. Default is importing all nets.
 layer          string. Import layer. Repeat to import several layers. Default is importing all layers.
 epsilonr       float.  Set dielectric epsilon r.
 xmin           float.  Crop pcb. Set lower bound of x coordinate.
 xmax           float.  Crop pcb. Set higher bound of x coordinate.
 ymin           float.  Crop pcb. Set lower bound of y coordinate.
 ymax           float.  Crop pcb. Set higher bound of y coordinate.
 zmin           float.  Crop pcb. Set lower bound of z coordinate.
 zmax           float.  Crop pcb. Set higher bound of z coordinate.
 grid           float.  Set output grid size.  (default = 10e-6 = 1 um)
 arc-precision  float.  Set maximum difference between perfect arc and polygonal approximation.
 clearance      float.  Set trace-to-plane clearance. (default = 0.0002)
 flood          string. Flood layer with copper. Repeat to flood several layers. The value "plane_layers" floods all plane layers.
 pcb-outline    none.   Detailed board outline.
 lossy-copper   none.   Model copper as lossy. Default is modeling copper as a perfect conductor.
 metal-3d       none.   Model copper as a 3D object. Default is modeling copper as a 2D sheet.
 version        none.   Print hyp2mat version number.

 ImportHyperLynx needs read and write access to the current directory.

 Examples:
 CSX = ImportHyperLynx(CSX, 'board.hyp' )
 will import the complete Hyperlynx file 'board.hyp' into the struct CSX.

 CSX = ImportHyperLynx(CSX, 'board.hyp', 'net', 'CLK_P' )
 will import only the CLK_P net from the Hyperlynx file 'board.hyp' into the struct CSX.

 CSX = ImportHyperLynx(CSX, 'board.hyp', 'net', '?' )
 lists all available nets.

 CSX = ImportHyperLynx(CSX, 'board.hyp', 'net', 'GND', 'net', 'CLK_P', 'net', 'CLK_N' )
 will import only the GND, CLK_P and CLK_N nets.

 CSX = ImportHyperLynx(CSX, 'board.hyp', 'xmin', 0.02, 'xmax', 0.03, 'ymin', 0.04, 'ymax', 0.05 )
 Imports all nets, and crops the board to the region 2 cm < x < 3 cm, 4 cm < y < 5 cm.

 See hyp2mat(1) - convert hyperlynx files to matlab scripts.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
 CSX = ImportHyperLynx(CSX, filename, varargin)
 load Hyperlynx file 'filenam...





