source: sasview/sansmodels/src/sans/models/c_models/CHardsphereStructure.cpp @ 01de557

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 01de557 was 0b082f3, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

Re #7 Enable openmp for all models
  • Property mode set to 100644
File size: 18.5 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, University of Tennessee
13 */
14
15/** CHardsphereStructure
16 *
17 * C extension
18 *
19 * WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
20 *          DO NOT MODIFY THIS FILE, MODIFY Hardsphere.h
21 *          AND RE-RUN THE GENERATOR SCRIPT
22 *
23 */
24#define NO_IMPORT_ARRAY
25#define PY_ARRAY_UNIQUE_SYMBOL PyArray_API_sans
26 
27extern "C" {
28#include <Python.h>
29#include <arrayobject.h>
30#include "structmember.h"
31#include <stdio.h>
32#include <stdlib.h>
33#include <math.h>
34#include <time.h>
35#include "Hardsphere.h"
36}
37
38#include "models.hh"
39#include "dispersion_visitor.hh"
40
41/// Error object for raised exceptions
42static PyObject * CHardsphereStructureError = NULL;
43
44
45// Class definition
46typedef struct {
47    PyObject_HEAD
48    /// Parameters
49    PyObject * params;
50    /// Dispersion parameters
51    PyObject * dispersion;
52    /// Underlying model object
53    HardsphereStructure * model;
54    /// Log for unit testing
55    PyObject * log;
56} CHardsphereStructure;
57
58
59static void
60CHardsphereStructure_dealloc(CHardsphereStructure* self)
61{
62    Py_DECREF(self->params);
63    Py_DECREF(self->dispersion);
64    Py_DECREF(self->log);
65    delete self->model;
66    self->ob_type->tp_free((PyObject*)self);
67   
68
69}
70
71static PyObject *
72CHardsphereStructure_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
73{
74    CHardsphereStructure *self;
75   
76    self = (CHardsphereStructure *)type->tp_alloc(type, 0);
77   
78    return (PyObject *)self;
79}
80
81static int
82CHardsphereStructure_init(CHardsphereStructure *self, PyObject *args, PyObject *kwds)
83{
84    if (self != NULL) {
85       
86        // Create parameters
87        self->params = PyDict_New();
88        self->dispersion = PyDict_New();
89        self->model = new HardsphereStructure();
90       
91        // Initialize parameter dictionary
92        PyDict_SetItemString(self->params,"effect_radius",Py_BuildValue("d",50.000000000000));
93        PyDict_SetItemString(self->params,"volfraction",Py_BuildValue("d",0.200000000000));
94        // Initialize dispersion / averaging parameter dict
95        DispersionVisitor* visitor = new DispersionVisitor();
96        PyObject * disp_dict;
97        disp_dict = PyDict_New();
98        self->model->effect_radius.dispersion->accept_as_source(visitor, self->model->effect_radius.dispersion, disp_dict);
99        PyDict_SetItemString(self->dispersion, "effect_radius", disp_dict);
100
101
102         
103        // Create empty log
104        self->log = PyDict_New();
105       
106       
107
108    }
109    return 0;
110}
111
112static char name_params[] = "params";
113static char def_params[] = "Parameters";
114static char name_dispersion[] = "dispersion";
115static char def_dispersion[] = "Dispersion parameters";
116static char name_log[] = "log";
117static char def_log[] = "Log";
118
119static PyMemberDef CHardsphereStructure_members[] = {
120    {name_params, T_OBJECT, offsetof(CHardsphereStructure, params), 0, def_params},
121        {name_dispersion, T_OBJECT, offsetof(CHardsphereStructure, dispersion), 0, def_dispersion},     
122    {name_log, T_OBJECT, offsetof(CHardsphereStructure, log), 0, def_log},
123    {NULL}  /* Sentinel */
124};
125
126/** Read double from PyObject
127    @param p PyObject
128    @return double
129*/
130double CHardsphereStructure_readDouble(PyObject *p) {
131    if (PyFloat_Check(p)==1) {
132        return (double)(((PyFloatObject *)(p))->ob_fval);
133    } else if (PyInt_Check(p)==1) {
134        return (double)(((PyIntObject *)(p))->ob_ival);
135    } else if (PyLong_Check(p)==1) {
136        return (double)PyLong_AsLong(p);
137    } else {
138        return 0.0;
139    }
140}
141/**
142 * Function to call to evaluate model
143 * @param args: input numpy array q[]
144 * @return: numpy array object
145 */
146 
147static PyObject *evaluateOneDim(HardsphereStructure* model, PyArrayObject *q){
148    PyArrayObject *result;
149   
150    // Check validity of array q , q must be of dimension 1, an array of double
151    if (q->nd != 1 || q->descr->type_num != PyArray_DOUBLE)
152    {
153        //const char * message= "Invalid array: q->nd=%d,type_num=%d\n",q->nd,q->descr->type_num;
154        //PyErr_SetString(PyExc_ValueError , message);
155        return NULL;
156    }
157    result = (PyArrayObject *)PyArray_FromDims(q->nd, (int *)(q->dimensions), 
158                                                                                  PyArray_DOUBLE);
159        if (result == NULL) {
160        const char * message= "Could not create result ";
161        PyErr_SetString(PyExc_RuntimeError , message);
162                return NULL;
163        }
164#pragma omp parallel for
165         for (int i = 0; i < q->dimensions[0]; i++){
166      double q_value  = *(double *)(q->data + i*q->strides[0]);
167      double *result_value = (double *)(result->data + i*result->strides[0]);
168      *result_value =(*model)(q_value);
169        }
170    return PyArray_Return(result); 
171 }
172
173 /**
174 * Function to call to evaluate model
175 * @param args: input numpy array  [x[],y[]]
176 * @return: numpy array object
177 */
178 static PyObject * evaluateTwoDimXY( HardsphereStructure* model, 
179                              PyArrayObject *x, PyArrayObject *y)
180 {
181    PyArrayObject *result;
182    int x_len, y_len, dims[1];
183    //check validity of input vectors
184    if (x->nd != 1 || x->descr->type_num != PyArray_DOUBLE
185        || y->nd != 1 || y->descr->type_num != PyArray_DOUBLE
186        || y->dimensions[0] != x->dimensions[0]){
187        const char * message= "evaluateTwoDimXY  expect 2 numpy arrays";
188        PyErr_SetString(PyExc_ValueError , message); 
189        return NULL;
190    }
191   
192        if (PyArray_Check(x) && PyArray_Check(y)) {
193               
194            x_len = dims[0]= x->dimensions[0];
195        y_len = dims[0]= y->dimensions[0];
196           
197            // Make a new double matrix of same dims
198        result=(PyArrayObject *) PyArray_FromDims(1,dims,NPY_DOUBLE);
199        if (result == NULL){
200            const char * message= "Could not create result ";
201        PyErr_SetString(PyExc_RuntimeError , message);
202            return NULL;
203            }
204       
205        /* Do the calculation. */
206#pragma omp parallel for
207        for (int i=0; i< x_len; i++) {
208            double x_value = *(double *)(x->data + i*x->strides[0]);
209                    double y_value = *(double *)(y->data + i*y->strides[0]);
210                        double *result_value = (double *)(result->data +
211                              i*result->strides[0]);
212                        *result_value = (*model)(x_value, y_value);
213        }           
214        return PyArray_Return(result); 
215       
216        }else{
217                    PyErr_SetString(CHardsphereStructureError, 
218                   "CHardsphereStructure.evaluateTwoDimXY couldn't run.");
219                return NULL;
220                }       
221}
222/**
223 *  evalDistribution function evaluate a model function with input vector
224 *  @param args: input q as vector or [qx, qy] where qx, qy are vectors
225 *
226 */ 
227static PyObject * evalDistribution(CHardsphereStructure *self, PyObject *args){
228        PyObject *qx, *qy;
229        PyArrayObject * pars;
230        int npars ,mpars;
231       
232        // Get parameters
233       
234            // Reader parameter dictionary
235    self->model->effect_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "effect_radius") );
236    self->model->volfraction = PyFloat_AsDouble( PyDict_GetItemString(self->params, "volfraction") );
237    // Read in dispersion parameters
238    PyObject* disp_dict;
239    DispersionVisitor* visitor = new DispersionVisitor();
240    disp_dict = PyDict_GetItemString(self->dispersion, "effect_radius");
241    self->model->effect_radius.dispersion->accept_as_destination(visitor, self->model->effect_radius.dispersion, disp_dict);
242
243       
244        // Get input and determine whether we have to supply a 1D or 2D return value.
245        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
246            PyErr_SetString(CHardsphereStructureError, 
247                "CHardsphereStructure.evalDistribution expects a q value.");
248                return NULL;
249        }
250    // Check params
251       
252    if(PyArray_Check(pars)==1) {
253               
254            // Length of list should 1 or 2
255            npars = pars->nd; 
256            if(npars==1) {
257                // input is a numpy array
258                if (PyArray_Check(pars)) {
259                        return evaluateOneDim(self->model, (PyArrayObject*)pars); 
260                    }
261                }else{
262                    PyErr_SetString(CHardsphereStructureError, 
263                   "CHardsphereStructure.evalDistribution expect numpy array of one dimension.");
264                return NULL;
265                }
266    }else if( PyList_Check(pars)==1) {
267        // Length of list should be 2 for I(qx,qy)
268            mpars = PyList_GET_SIZE(pars); 
269            if(mpars!=2) {
270                PyErr_SetString(CHardsphereStructureError, 
271                        "CHardsphereStructure.evalDistribution expects a list of dimension 2.");
272                return NULL;
273            }
274             qx = PyList_GET_ITEM(pars,0);
275             qy = PyList_GET_ITEM(pars,1);
276             if (PyArray_Check(qx) && PyArray_Check(qy)) {
277                 return evaluateTwoDimXY(self->model, (PyArrayObject*)qx,
278                           (PyArrayObject*)qy);
279                 }else{
280                    PyErr_SetString(CHardsphereStructureError, 
281                   "CHardsphereStructure.evalDistribution expect 2 numpy arrays in list.");
282                return NULL;
283             }
284        }
285        PyErr_SetString(CHardsphereStructureError, 
286                   "CHardsphereStructure.evalDistribution couln't be run.");
287        return NULL;
288       
289}
290
291/**
292 * Function to call to evaluate model
293 * @param args: input q or [q,phi]
294 * @return: function value
295 */
296static PyObject * run(CHardsphereStructure *self, PyObject *args) {
297        double q_value, phi_value;
298        PyObject* pars;
299        int npars;
300       
301        // Get parameters
302       
303            // Reader parameter dictionary
304    self->model->effect_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "effect_radius") );
305    self->model->volfraction = PyFloat_AsDouble( PyDict_GetItemString(self->params, "volfraction") );
306    // Read in dispersion parameters
307    PyObject* disp_dict;
308    DispersionVisitor* visitor = new DispersionVisitor();
309    disp_dict = PyDict_GetItemString(self->dispersion, "effect_radius");
310    self->model->effect_radius.dispersion->accept_as_destination(visitor, self->model->effect_radius.dispersion, disp_dict);
311
312       
313        // Get input and determine whether we have to supply a 1D or 2D return value.
314        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
315            PyErr_SetString(CHardsphereStructureError, 
316                "CHardsphereStructure.run expects a q value.");
317                return NULL;
318        }
319         
320        // Check params
321        if( PyList_Check(pars)==1) {
322               
323                // Length of list should be 2 for I(q,phi)
324            npars = PyList_GET_SIZE(pars); 
325            if(npars!=2) {
326                PyErr_SetString(CHardsphereStructureError, 
327                        "CHardsphereStructure.run expects a double or a list of dimension 2.");
328                return NULL;
329            }
330            // We have a vector q, get the q and phi values at which
331            // to evaluate I(q,phi)
332            q_value = CHardsphereStructure_readDouble(PyList_GET_ITEM(pars,0));
333            phi_value = CHardsphereStructure_readDouble(PyList_GET_ITEM(pars,1));
334            // Skip zero
335            if (q_value==0) {
336                return Py_BuildValue("d",0.0);
337            }
338                return Py_BuildValue("d",(*(self->model)).evaluate_rphi(q_value,phi_value));
339
340        } else {
341
342                // We have a scalar q, we will evaluate I(q)
343                q_value = CHardsphereStructure_readDouble(pars);               
344               
345                return Py_BuildValue("d",(*(self->model))(q_value));
346        }       
347}
348/**
349 * Function to call to calculate_ER
350 * @return: effective radius value
351 */
352static PyObject * calculate_ER(CHardsphereStructure *self) {
353
354        // Get parameters
355       
356            // Reader parameter dictionary
357    self->model->effect_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "effect_radius") );
358    self->model->volfraction = PyFloat_AsDouble( PyDict_GetItemString(self->params, "volfraction") );
359    // Read in dispersion parameters
360    PyObject* disp_dict;
361    DispersionVisitor* visitor = new DispersionVisitor();
362    disp_dict = PyDict_GetItemString(self->dispersion, "effect_radius");
363    self->model->effect_radius.dispersion->accept_as_destination(visitor, self->model->effect_radius.dispersion, disp_dict);
364
365               
366        return Py_BuildValue("d",(*(self->model)).calculate_ER());
367
368}
369/**
370 * Function to call to evaluate model in cartesian coordinates
371 * @param args: input q or [qx, qy]]
372 * @return: function value
373 */
374static PyObject * runXY(CHardsphereStructure *self, PyObject *args) {
375        double qx_value, qy_value;
376        PyObject* pars;
377        int npars;
378       
379        // Get parameters
380       
381            // Reader parameter dictionary
382    self->model->effect_radius = PyFloat_AsDouble( PyDict_GetItemString(self->params, "effect_radius") );
383    self->model->volfraction = PyFloat_AsDouble( PyDict_GetItemString(self->params, "volfraction") );
384    // Read in dispersion parameters
385    PyObject* disp_dict;
386    DispersionVisitor* visitor = new DispersionVisitor();
387    disp_dict = PyDict_GetItemString(self->dispersion, "effect_radius");
388    self->model->effect_radius.dispersion->accept_as_destination(visitor, self->model->effect_radius.dispersion, disp_dict);
389
390       
391        // Get input and determine whether we have to supply a 1D or 2D return value.
392        if ( !PyArg_ParseTuple(args,"O",&pars) ) {
393            PyErr_SetString(CHardsphereStructureError, 
394                "CHardsphereStructure.run expects a q value.");
395                return NULL;
396        }
397         
398        // Check params
399        if( PyList_Check(pars)==1) {
400               
401                // Length of list should be 2 for I(qx, qy))
402            npars = PyList_GET_SIZE(pars); 
403            if(npars!=2) {
404                PyErr_SetString(CHardsphereStructureError, 
405                        "CHardsphereStructure.run expects a double or a list of dimension 2.");
406                return NULL;
407            }
408            // We have a vector q, get the qx and qy values at which
409            // to evaluate I(qx,qy)
410            qx_value = CHardsphereStructure_readDouble(PyList_GET_ITEM(pars,0));
411            qy_value = CHardsphereStructure_readDouble(PyList_GET_ITEM(pars,1));
412            return Py_BuildValue("d",(*(self->model))(qx_value,qy_value));
413
414        } else {
415
416                // We have a scalar q, we will evaluate I(q)
417                qx_value = CHardsphereStructure_readDouble(pars);               
418               
419                return Py_BuildValue("d",(*(self->model))(qx_value));
420        }       
421}
422
423static PyObject * reset(CHardsphereStructure *self, PyObject *args) {
424   
425
426    return Py_BuildValue("d",0.0);
427}
428
429static PyObject * set_dispersion(CHardsphereStructure *self, PyObject *args) {
430        PyObject * disp;
431        const char * par_name;
432
433        if ( !PyArg_ParseTuple(args,"sO", &par_name, &disp) ) {
434            PyErr_SetString(CHardsphereStructureError,
435                "CHardsphereStructure.set_dispersion expects a DispersionModel object.");
436                return NULL;
437        }
438        void *temp = PyCObject_AsVoidPtr(disp);
439        DispersionModel * dispersion = static_cast<DispersionModel *>(temp);
440
441
442        // Ugliness necessary to go from python to C
443            // TODO: refactor this
444    if (!strcmp(par_name, "effect_radius")) {
445        self->model->effect_radius.dispersion = dispersion;
446    } else {
447            PyErr_SetString(CHardsphereStructureError,
448                "CHardsphereStructure.set_dispersion expects a valid parameter name.");
449                return NULL;
450        }
451
452        DispersionVisitor* visitor = new DispersionVisitor();
453        PyObject * disp_dict = PyDict_New();
454        dispersion->accept_as_source(visitor, dispersion, disp_dict);
455        PyDict_SetItemString(self->dispersion, par_name, disp_dict);
456    return Py_BuildValue("i",1);
457}
458
459
460static PyMethodDef CHardsphereStructure_methods[] = {
461    {"run",      (PyCFunction)run     , METH_VARARGS,
462      "Evaluate the model at a given Q or Q, phi"},
463    {"runXY",      (PyCFunction)runXY     , METH_VARARGS,
464      "Evaluate the model at a given Q or Qx, Qy"},
465    {"calculate_ER",      (PyCFunction)calculate_ER     , METH_VARARGS,
466      "Evaluate the model at a given Q or Q, phi"},
467     
468    {"evalDistribution",  (PyCFunction)evalDistribution , METH_VARARGS,
469      "Evaluate the model at a given Q or Qx, Qy vector "},
470    {"reset",    (PyCFunction)reset   , METH_VARARGS,
471      "Reset pair correlation"},
472    {"set_dispersion",      (PyCFunction)set_dispersion     , METH_VARARGS,
473      "Set the dispersion model for a given parameter"},
474   {NULL}
475};
476
477static PyTypeObject CHardsphereStructureType = {
478    PyObject_HEAD_INIT(NULL)
479    0,                         /*ob_size*/
480    "CHardsphereStructure",             /*tp_name*/
481    sizeof(CHardsphereStructure),             /*tp_basicsize*/
482    0,                         /*tp_itemsize*/
483    (destructor)CHardsphereStructure_dealloc, /*tp_dealloc*/
484    0,                         /*tp_print*/
485    0,                         /*tp_getattr*/
486    0,                         /*tp_setattr*/
487    0,                         /*tp_compare*/
488    0,                         /*tp_repr*/
489    0,                         /*tp_as_number*/
490    0,                         /*tp_as_sequence*/
491    0,                         /*tp_as_mapping*/
492    0,                         /*tp_hash */
493    0,                         /*tp_call*/
494    0,                         /*tp_str*/
495    0,                         /*tp_getattro*/
496    0,                         /*tp_setattro*/
497    0,                         /*tp_as_buffer*/
498    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
499    "CHardsphereStructure objects",           /* tp_doc */
500    0,                         /* tp_traverse */
501    0,                         /* tp_clear */
502    0,                         /* tp_richcompare */
503    0,                         /* tp_weaklistoffset */
504    0,                         /* tp_iter */
505    0,                         /* tp_iternext */
506    CHardsphereStructure_methods,             /* tp_methods */
507    CHardsphereStructure_members,             /* tp_members */
508    0,                         /* tp_getset */
509    0,                         /* tp_base */
510    0,                         /* tp_dict */
511    0,                         /* tp_descr_get */
512    0,                         /* tp_descr_set */
513    0,                         /* tp_dictoffset */
514    (initproc)CHardsphereStructure_init,      /* tp_init */
515    0,                         /* tp_alloc */
516    CHardsphereStructure_new,                 /* tp_new */
517};
518
519
520//static PyMethodDef module_methods[] = {
521//    {NULL}
522//};
523
524/**
525 * Function used to add the model class to a module
526 * @param module: module to add the class to
527 */ 
528void addCHardsphereStructure(PyObject *module) {
529        PyObject *d;
530       
531    if (PyType_Ready(&CHardsphereStructureType) < 0)
532        return;
533
534    Py_INCREF(&CHardsphereStructureType);
535    PyModule_AddObject(module, "CHardsphereStructure", (PyObject *)&CHardsphereStructureType);
536   
537    d = PyModule_GetDict(module);
538    static char error_name[] = "CHardsphereStructure.error";
539    CHardsphereStructureError = PyErr_NewException(error_name, NULL, NULL);
540    PyDict_SetItemString(d, "CHardsphereStructureError", CHardsphereStructureError);
541}
542
Note: See TracBrowser for help on using the repository browser.