File: nec_structure_currents.py

package info (click to toggle)
necpp 1.2.4%2Bcvs20060601-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 3,764 kB
  • ctags: 5,989
  • sloc: cpp: 30,174; ansic: 10,162; fortran: 8,333; python: 2,948; makefile: 186; sh: 1
file content (492 lines) | stat: -rw-r--r-- 15,614 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
#nec_structure_currents.py

#header generated by SWIG

import _PyNEC

def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
    if (name == "this"):
        if isinstance(value, class_type):
            self.__dict__[name] = value.this
            if hasattr(value,"thisown"): self.__dict__["thisown"] = value.thisown
            del value.thisown
            return
    method = class_type.__swig_setmethods__.get(name,None)
    if method: return method(self,value)
    if (not static) or hasattr(self,name) or (name == "thisown"):
        self.__dict__[name] = value
    else:
        raise AttributeError("You cannot add attributes to %s" % self)

def _swig_setattr(self,class_type,name,value):
    return _swig_setattr_nondynamic(self,class_type,name,value,0)

def _swig_getattr(self,class_type,name):
    method = class_type.__swig_getmethods__.get(name,None)
    if method: return method(self)
    raise AttributeError,name

import types
try:
    _object = types.ObjectType
    _newclass = 1
except AttributeError:
    class _object : pass
    _newclass = 0
del types

#end of the header generated by SWIG



import exceptions

#some utility functions

def _get_iptflg(arg0):
	"""
	Returns the flag which controls the printing of the currents.
	"""
    	return _PyNEC.nec_structure_currents_get_iptflg(arg0)


def _get_iptflq(arg0):
	"""
	Returns the flag which controls the printing of charge densities.
	"""
    	return _PyNEC.nec_structure_currents_get_iptflq(arg0)

	
def _get_n(arg0):
	"""
	Returns the number the wire segments in the geometry.
	"""
    	return _PyNEC.nec_structure_currents_get_n(arg0)

    
def _get_m(arg0):
	"""
	Returns the number of patches in the geometry.
	"""
    	return _PyNEC.nec_structure_currents_get_m(arg0)    



#class "nec_structure_currents"

class nec_structure_currents(_object):
    __swig_setmethods__ = {}
    __setattr__ = lambda self, name, value: _swig_setattr(self, nec_structure_currents, name, value)
    __swig_getmethods__ = {}
    __getattr__ = lambda self, name: _swig_getattr(self, nec_structure_currents, name)
    def __init__(self): raise RuntimeError, "No constructor defined"
    def __repr__(self):
        return "<%s.%s; proxy of C++ nec_structure_currents instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
	    
    def get_frequency(*args):
    	"""
	Returns the frequency in Hertz.
	"""
    	return _PyNEC.nec_structure_currents_get_frequency(*args)
    
    
    def get_current_output_format(*args):
    	"""
	Returns the output format used for the printing of currents, provided it has been requested.
	"""
    	_iptflg = _get_iptflg(*args)
	if _iptflg != -1:
		if _iptflg == -2 or _iptflg == 0 :
			return 'Standard output format'
		elif _iptflg == 1 or _iptflg == 2 :
			return 'Format designed for a receiving pattern'
		else :
			error_msg = "Unknown output format."
			raise exceptions.Warning(error_msg)
	
    
    def get_current_segment_number(*args) :
    	"""
	Returns the array of segment numbers for the printing of currrents.
	"""
    	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			return _PyNEC.nec_structure_currents_get_current_segment_number(*args)
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_current_segment_tag(*args):
    	"""
	Returns the array of segment tag numbers for the printing of currents, provided the standard output format has been requested.
	"""
	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			if _iptflg == -2 or _iptflg == 0 :
				return _PyNEC.nec_structure_currents_get_current_segment_tag(*args)
			else :
				error_msg = "Wrong ouptut format."
				raise exceptions.Warning(error_msg) 
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_current_segment_center_x(*args):
    	"""
	Returns the array of x-coordinate of segment centers in wavelengths for the printing of currents, provided the standard output format has been requested.
	"""
	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			if _iptflg == -2 or _iptflg == 0 :
				return _PyNEC.nec_structure_currents_get_current_segment_center_x(*args)
			else :
				error_msg = "Wrong ouptut format."
				raise exceptions.Warning(error_msg) 
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_current_segment_center_y(*args):
    	"""
	Returns the array of y-coordinate of segment centers in wavelengths for the printing of currents, provided the standard output format has been requested.
	"""
	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			if _iptflg == -2 or _iptflg == 0 :
				return _PyNEC.nec_structure_currents_get_current_segment_center_y(*args)
			else :
				error_msg = "Wrong ouptut format."
				raise exceptions.Warning(error_msg)
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_current_segment_center_z(*args):
    	"""
	Returns the array of z-coordinate of segment centers in wavelengths for the printing of currents, provided the standard output format has been requested.
	"""
	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			if _iptflg == -2 or _iptflg == 0 :
				return _PyNEC.nec_structure_currents_get_current_segment_center_z(*args)
			else :
				error_msg = "Wrong ouptut format."
				raise exceptions.Warning(error_msg)
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_current_segment_length(*args):
    	"""
	Returns the array of segment lengths in wavelengths for the printing of currents, provided the standard output format has been requested.
	"""
    	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			if _iptflg == -2 or _iptflg == 0 :
				return _PyNEC.nec_structure_currents_get_current_segment_length(*args)
			else :
				error_msg = "Wrong ouptut format."
				raise exceptions.Warning(error_msg)
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)	
	
	
    def get_current_theta(*args):
    	"""
	Returns the array of theta angles in degrees for the printing of currents, provided the format designed for a receiving pattern has been requested.
	"""
    	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			if _iptflg == 1 or _iptflg == 2 :
				return _PyNEC.nec_structure_currents_get_current_theta(*args)
			else : 
				error_msg = "Wrong ouptut format."
				raise exceptions.Warning(error_msg)	
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_current_phi(*args):
    	"""
	Returns the array of phi angles in degrees for the printing of currents, provided the format designed for a receiving pattern has been requested.
	"""
    	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			if _iptflg == 1 or _iptflg == 2 :
				return _PyNEC.nec_structure_currents_get_current_phi(*args)
			else : 
				error_msg = "Wrong ouptut format."
				raise exceptions.Warning(error_msg)
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_current(*args):
    	"""
	Returns the array of complex currents in Ampere.
	"""
    	if _get_n(*args) != 0 :
		_iptflg = _get_iptflg(*args)
		if _iptflg != -1 :
			return _PyNEC.nec_structure_currents_get_current(*args)
		else :
			error_msg = "The printing of currents has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)


	
    def get_q_density_segment_number(*args):
    	"""
	Returns the array of segment numbers for the printing of charge densities.
	"""
    	if _get_n(*args) != 0 :
		if _get_iptflq(*args) != -1 :
			return _PyNEC.nec_structure_currents_get_q_density_segment_number(*args)
		else :
			error_msg = "The printing of charge densities has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_q_density_segment_tag(*args):
    	"""
	Returns the array of segment tag numbers for the printing of charge densities.
	"""
    	if _get_n(*args) != 0 :
		if _get_iptflq(*args) != -1 :
			return _PyNEC.nec_structure_currents_get_q_density_segment_tag(*args)
		else :
			error_msg = "The printing of charge densities has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_q_density_segment_center_x(*args):
    	"""
	Returns the array of x-coordinate of segment centers in wavelengths for the printing of charge densities.
	"""
    	if _get_n(*args) != 0 :
		if _get_iptflq(*args) != -1 :
			return _PyNEC.nec_structure_currents_get_q_density_segment_center_x(*args)
		else :
			error_msg = "The printing of charge densities has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_q_density_segment_center_y(*args):
    	"""
	Returns the array of y-coordinate of segment centers in wavelengths for the printing of charge densities.
	"""
	if _get_n(*args) != 0 :
		if _get_iptflq(*args) != -1 :
			return _PyNEC.nec_structure_currents_get_q_density_segment_center_y(*args)
		else :
			error_msg = "The printing of charge densities has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_q_density_segment_center_z(*args):
    	"""
	Returns the array of z-coordinate of segment centers in wavelengths for the printing of charge densities.
	"""
	if _get_n(*args) != 0 :
		if _get_iptflq(*args) != -1 :
			return _PyNEC.nec_structure_currents_get_q_density_segment_center_z(*args)
		else :
			error_msg = "The printing of charge densities has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_q_density_segment_length(*args):
    	"""
	Returns the array of segment lengths in wavelengths for the printing of charge densities.
	"""
	if _get_n(*args) != 0 :
		if _get_iptflq(*args) != -1 :
			return _PyNEC.nec_structure_currents_get_q_density_segment_length(*args)
		else :
			error_msg = "The printing of charge densities has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
    
    
    def get_q_density(*args):
    	"""
	Returns the array of complex charge densities in Coulomb/meter.
	"""
    	if _get_n(*args) != 0 :
		if _get_iptflq(*args) != -1 :
			return _PyNEC.nec_structure_currents_get_q_density(*args)
		else :
			error_msg = "The printing of charge densities has not been requested."
			raise exceptions.Warning(error_msg);
	else :
		error_msg = "There are no wires in the structure."
		raise exceptions.Warning(error_msg)
	
    
    
    def get_patch_number(*args):
    	"""
	Returns the array of patch numbers.
	"""
    	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_number(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
	
	
    def get_patch_center_x(*args):
    	"""
	Returns the array of x-coordinate in wavelengths of patch centers.
	"""
    	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_center_x(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
		
		
    def get_patch_center_y(*args):
    	"""
	Returns the array of y-coordinate in wavelengths of patch centers.
	"""
	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_center_y(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
		
		
    def get_patch_center_z(*args):
    	"""
	Returns the array of z-coordinate in wavelengths of patch centers.
	"""
	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_center_z(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
		
		
    def get_patch_tangent_vector1(*args):
    	"""
	Returns the array of complex currents (in Amps/meter) along tangent vector 1 of the patches.
	"""
    	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_tangent_vector1(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
	
		
    def get_patch_tangent_vector2(*args):
    	"""
	Returns the array of complex currents (in Amps/meter) along tangent vector 2 of the patches.
	"""
    	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_tangent_vector2(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
	
		
    def get_patch_e_x(*args):
    	"""
	Returns the complex x-component of the currents (in Amps/meter).
	"""
    	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_e_x(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
	
		
    def get_patch_e_y(*args):
    	"""
	Returns the complex y-component of the currents (in Amps/meter).
	"""
    	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_e_y(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
	
		
    def get_patch_e_z(*args):
    	"""
	Returns the complex z-component of the currents (in Amps/meter).
	"""
    	if _get_m(*args) != 0 :
		return _PyNEC.nec_structure_currents_get_patch_e_z(*args)
	else :
		error_msg = "There are no patches in the structure."
		raise exceptions.Warning(error_msg)
		
		

class nec_structure_currentsPtr(nec_structure_currents):
    def __init__(self, this):
        _swig_setattr(self, nec_structure_currents, 'this', this)
        if not hasattr(self,"thisown"): _swig_setattr(self, nec_structure_currents, 'thisown', 0)
        _swig_setattr(self, nec_structure_currents,self.__class__,nec_structure_currents)
_PyNEC.nec_structure_currents_swigregister(nec_structure_currentsPtr)