ReflAdvModel.py @ 81b524f

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload

Last change on this file since 81b524f was 81b524f, checked in by Jeff Krzywon <jeffery.krzywon@…>, 11 years ago
This branch is now merged with the latest trunk release. I will merge them next.
Property mode set to `100644`
File size: 12.6 KB

Line
1	##############################################################################
2	# This software was developed by the University of Tennessee as part of the
3	# Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
4	# project funded by the US National Science Foundation.
5	#
6	# If you use DANSE applications to do scientific research that leads to
7	# publication, we ask that you acknowledge the use of the software with the
8	# following sentence:
9	#
10	# This work benefited from DANSE software developed under NSF award DMR-0520547
11	#
12	# Copyright 2008-2011, University of Tennessee
13	##############################################################################
14
15	"""
16	Provide functionality for a C extension model
17
18	:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
19	DO NOT MODIFY THIS FILE, MODIFY
20	src\sans\models\include\refl_adv.h
21	AND RE-RUN THE GENERATOR SCRIPT
22	"""
23
24	from sans.models.BaseComponent import BaseComponent
25	from sans.models.sans_extension.c_models import CReflAdvModel
26
27	def create_ReflAdvModel():
28	"""
29	Create a model instance
30	"""
31	obj = ReflAdvModel()
32	# CReflAdvModel.__init__(obj) is called by
33	# the ReflAdvModel constructor
34	return obj
35
36	class ReflAdvModel(CReflAdvModel, BaseComponent):
37	"""
38	Class that evaluates a ReflAdvModel model.
39	This file was auto-generated from src\sans\models\include\refl_adv.h.
40	Refer to that file and the structure it contains
41	for details of the model.
42	List of default parameters:
43	n_layers = 1.0
44	scale = 1.0
45	thick_inter0 = 50.0 [A]
46	func_inter0 = 0.0
47	sld_bottom0 = 2.07e-06 [1/A^(2)]
48	sld_medium = 1e-06 [1/A^(2)]
49	background = 0.0
50	sld_flat1 = 4e-06 [1/A^(2)]
51	sld_flat2 = 3.5e-06 [1/A^(2)]
52	sld_flat3 = 4e-06 [1/A^(2)]
53	sld_flat4 = 3.5e-06 [1/A^(2)]
54	sld_flat5 = 4e-06 [1/A^(2)]
55	sld_flat6 = 3.5e-06 [1/A^(2)]
56	sld_flat7 = 4e-06 [1/A^(2)]
57	sld_flat8 = 3.5e-06 [1/A^(2)]
58	sld_flat9 = 4e-06 [1/A^(2)]
59	sld_flat10 = 3.5e-06 [1/A^(2)]
60	thick_inter1 = 50.0 [A]
61	thick_inter2 = 50.0 [A]
62	thick_inter3 = 50.0 [A]
63	thick_inter4 = 50.0 [A]
64	thick_inter5 = 50.0 [A]
65	thick_inter6 = 50.0 [A]
66	thick_inter7 = 50.0 [A]
67	thick_inter8 = 50.0 [A]
68	thick_inter9 = 50.0 [A]
69	thick_inter10 = 50.0 [A]
70	thick_flat1 = 100.0 [A]
71	thick_flat2 = 100.0 [A]
72	thick_flat3 = 100.0 [A]
73	thick_flat4 = 100.0 [A]
74	thick_flat5 = 100.0 [A]
75	thick_flat6 = 100.0 [A]
76	thick_flat7 = 100.0 [A]
77	thick_flat8 = 100.0 [A]
78	thick_flat9 = 100.0 [A]
79	thick_flat10 = 100.0 [A]
80	func_inter1 = 0.0
81	func_inter2 = 0.0
82	func_inter3 = 0.0
83	func_inter4 = 0.0
84	func_inter5 = 0.0
85	func_inter6 = 0.0
86	func_inter7 = 0.0
87	func_inter8 = 0.0
88	func_inter9 = 0.0
89	func_inter10 = 0.0
90	sldIM_flat1 = 0.0 [1/A^(2)]
91	sldIM_flat2 = 0.0 [1/A^(2)]
92	sldIM_flat3 = 0.0 [1/A^(2)]
93	sldIM_flat4 = 0.0 [1/A^(2)]
94	sldIM_flat5 = 0.0 [1/A^(2)]
95	sldIM_flat6 = 0.0 [1/A^(2)]
96	sldIM_flat7 = 0.0 [1/A^(2)]
97	sldIM_flat8 = 0.0 [1/A^(2)]
98	sldIM_flat9 = 0.0 [1/A^(2)]
99	sldIM_flat10 = 0.0 [1/A^(2)]
100	nu_inter1 = 2.5
101	nu_inter2 = 2.5
102	nu_inter3 = 2.5
103	nu_inter4 = 2.5
104	nu_inter5 = 2.5
105	nu_inter6 = 2.5
106	nu_inter7 = 2.5
107	nu_inter8 = 2.5
108	nu_inter9 = 2.5
109	nu_inter10 = 2.5
110	sldIM_sub0 = 0.0
111	sldIM_medium = 0.0
112	npts_inter = 21.0
113	nu_inter0 = 2.5
114
115	"""
116
117	def __init__(self, multfactor=1):
118	""" Initialization """
119	self.__dict__ = {}
120
121	# Initialize BaseComponent first, then sphere
122	BaseComponent.__init__(self)
123	#apply(CReflAdvModel.__init__, (self,))
124
125	CReflAdvModel.__init__(self)
126	self.is_multifunc = False
127
128	## Name of the model
129	self.name = "ReflAdvModel"
130	## Model description
131	self.description = """
132	Calculate neutron reflectivity using the Parratt iterative formula
133	Parameters:
134	background:background
135	scale: scale factor
136	sld_bottom0: the SLD of the substrate
137	sld_medium: the SLD of the incident medium
138	or superstrate
139	sld_flatN: the SLD of the flat region of
140	the N'th layer
141	thick_flatN: the thickness of the flat
142	region of the N'th layer
143	func_interN: the function used to describe
144	the interface of the N'th layer
145	nu_interN: the coefficient for the func_interN
146	thick_interN: the thickness of the interface
147	of the N'th layer
148	Note: the layer number starts to increase
149	from the bottom (substrate) to the top.
150	"""
151
152	## Parameter details [units, min, max]
153	self.details = {}
154	self.details['n_layers'] = ['', None, None]
155	self.details['scale'] = ['', None, None]
156	self.details['thick_inter0'] = ['[A]', None, None]
157	self.details['func_inter0'] = ['', None, None]
158	self.details['sld_bottom0'] = ['[1/A^(2)]', None, None]
159	self.details['sld_medium'] = ['[1/A^(2)]', None, None]
160	self.details['background'] = ['', None, None]
161	self.details['sld_flat1'] = ['[1/A^(2)]', None, None]
162	self.details['sld_flat2'] = ['[1/A^(2)]', None, None]
163	self.details['sld_flat3'] = ['[1/A^(2)]', None, None]
164	self.details['sld_flat4'] = ['[1/A^(2)]', None, None]
165	self.details['sld_flat5'] = ['[1/A^(2)]', None, None]
166	self.details['sld_flat6'] = ['[1/A^(2)]', None, None]
167	self.details['sld_flat7'] = ['[1/A^(2)]', None, None]
168	self.details['sld_flat8'] = ['[1/A^(2)]', None, None]
169	self.details['sld_flat9'] = ['[1/A^(2)]', None, None]
170	self.details['sld_flat10'] = ['[1/A^(2)]', None, None]
171	self.details['thick_inter1'] = ['[A]', None, None]
172	self.details['thick_inter2'] = ['[A]', None, None]
173	self.details['thick_inter3'] = ['[A]', None, None]
174	self.details['thick_inter4'] = ['[A]', None, None]
175	self.details['thick_inter5'] = ['[A]', None, None]
176	self.details['thick_inter6'] = ['[A]', None, None]
177	self.details['thick_inter7'] = ['[A]', None, None]
178	self.details['thick_inter8'] = ['[A]', None, None]
179	self.details['thick_inter9'] = ['[A]', None, None]
180	self.details['thick_inter10'] = ['[A]', None, None]
181	self.details['thick_flat1'] = ['[A]', None, None]
182	self.details['thick_flat2'] = ['[A]', None, None]
183	self.details['thick_flat3'] = ['[A]', None, None]
184	self.details['thick_flat4'] = ['[A]', None, None]
185	self.details['thick_flat5'] = ['[A]', None, None]
186	self.details['thick_flat6'] = ['[A]', None, None]
187	self.details['thick_flat7'] = ['[A]', None, None]
188	self.details['thick_flat8'] = ['[A]', None, None]
189	self.details['thick_flat9'] = ['[A]', None, None]
190	self.details['thick_flat10'] = ['[A]', None, None]
191	self.details['func_inter1'] = ['', None, None]
192	self.details['func_inter2'] = ['', None, None]
193	self.details['func_inter3'] = ['', None, None]
194	self.details['func_inter4'] = ['', None, None]
195	self.details['func_inter5'] = ['', None, None]
196	self.details['func_inter6'] = ['', None, None]
197	self.details['func_inter7'] = ['', None, None]
198	self.details['func_inter8'] = ['', None, None]
199	self.details['func_inter9'] = ['', None, None]
200	self.details['func_inter10'] = ['', None, None]
201	self.details['sldIM_flat1'] = ['[1/A^(2)]', None, None]
202	self.details['sldIM_flat2'] = ['[1/A^(2)]', None, None]
203	self.details['sldIM_flat3'] = ['[1/A^(2)]', None, None]
204	self.details['sldIM_flat4'] = ['[1/A^(2)]', None, None]
205	self.details['sldIM_flat5'] = ['[1/A^(2)]', None, None]
206	self.details['sldIM_flat6'] = ['[1/A^(2)]', None, None]
207	self.details['sldIM_flat7'] = ['[1/A^(2)]', None, None]
208	self.details['sldIM_flat8'] = ['[1/A^(2)]', None, None]
209	self.details['sldIM_flat9'] = ['[1/A^(2)]', None, None]
210	self.details['sldIM_flat10'] = ['[1/A^(2)]', None, None]
211	self.details['nu_inter1'] = ['', None, None]
212	self.details['nu_inter2'] = ['', None, None]
213	self.details['nu_inter3'] = ['', None, None]
214	self.details['nu_inter4'] = ['', None, None]
215	self.details['nu_inter5'] = ['', None, None]
216	self.details['nu_inter6'] = ['', None, None]
217	self.details['nu_inter7'] = ['', None, None]
218	self.details['nu_inter8'] = ['', None, None]
219	self.details['nu_inter9'] = ['', None, None]
220	self.details['nu_inter10'] = ['', None, None]
221	self.details['sldIM_sub0'] = ['', None, None]
222	self.details['sldIM_medium'] = ['', None, None]
223	self.details['npts_inter'] = ['', None, None]
224	self.details['nu_inter0'] = ['', None, None]
225
226	## fittable parameters
227	self.fixed = []
228
229	## non-fittable parameters
230	self.non_fittable = ['n_layers',
231	'func_inter0',
232	'func_inter1',
233	'func_inter2',
234	'func_inter3',
235	'func_inter4',
236	'func_inter5',
237	'func_inter5',
238	'func_inter7',
239	'func_inter8',
240	'func_inter9',
241	'func_inter10']
242
243	## parameters with orientation
244	self.orientation_params = []
245
246	## parameters with magnetism
247	self.magnetic_params = []
248
249	self.category = None
250	self.multiplicity_info = None
251
252	def __setstate__(self, state):
253	"""
254	restore the state of a model from pickle
255	"""
256	self.__dict__, self.params, self.dispersion = state
257
258	def __reduce_ex__(self, proto):
259	"""
260	Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
261	c model.
262	"""
263	state = (self.__dict__, self.params, self.dispersion)
264	return (create_ReflAdvModel, tuple(), state, None, None)
265
266	def clone(self):
267	""" Return a identical copy of self """
268	return self._clone(ReflAdvModel())
269
270	def run(self, x=0.0):
271	"""
272	Evaluate the model
273
274	:param x: input q, or [q,phi]
275
276	:return: scattering function P(q)
277
278	"""
279	return CReflAdvModel.run(self, x)
280
281	def runXY(self, x=0.0):
282	"""
283	Evaluate the model in cartesian coordinates
284
285	:param x: input q, or [qx, qy]
286
287	:return: scattering function P(q)
288
289	"""
290	return CReflAdvModel.runXY(self, x)
291
292	def evalDistribution(self, x):
293	"""
294	Evaluate the model in cartesian coordinates
295
296	:param x: input q[], or [qx[], qy[]]
297
298	:return: scattering function P(q[])
299
300	"""
301	return CReflAdvModel.evalDistribution(self, x)
302
303	def calculate_ER(self):
304	"""
305	Calculate the effective radius for P(q)*S(q)
306
307	:return: the value of the effective radius
308
309	"""
310	return CReflAdvModel.calculate_ER(self)
311
312	def calculate_VR(self):
313	"""
314	Calculate the volf ratio for P(q)*S(q)
315
316	:return: the value of the volf ratio
317
318	"""
319	return CReflAdvModel.calculate_VR(self)
320
321	def set_dispersion(self, parameter, dispersion):
322	"""
323	Set the dispersion object for a model parameter
324
325	:param parameter: name of the parameter [string]
326	:param dispersion: dispersion object of type DispersionModel
327
328	"""
329	return CReflAdvModel.set_dispersion(self,
330	parameter, dispersion.cdisp)
331
332
333	# End of file
334

Note: See TracBrowser for help on using the repository browser.

SasView

source: sasview/src/sans/models/ReflAdvModel.py @ 81b524f

Download in other formats: