source: sasview/sansmodels/src/sans/models/DiamEllipFunc.py @ d37ba31

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 d37ba31 was 40945a3, checked in by Jae Cho <jhjcho@…>, 16 years ago

Added 2nd virial coeff. functions

  • Property mode set to 100644
File size: 3.2 KB
Line 
1#!/usr/bin/env python
2"""
3        This software was developed by the University of Tennessee as part of the
4        Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
5        project funded by the US National Science Foundation.
6
7        If you use DANSE applications to do scientific research that leads to
8        publication, we ask that you acknowledge the use of the software with the
9        following sentence:
10
11        "This work benefited from DANSE software developed under NSF award DMR-0520547."
12
13        copyright 2008, University of Tennessee
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 C:\ECLPS\workspace\trunk\sansmodels\src\sans\models\c_extensions\DiamEllip.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CDiamEllipFunc
26import copy   
27   
28class DiamEllipFunc(CDiamEllipFunc, BaseComponent):
29    """ Class that evaluates a DiamEllipFunc model.
30        This file was auto-generated from C:\ECLPS\workspace\trunk\sansmodels\src\sans\models\c_extensions\DiamEllip.h.
31        Refer to that file and the structure it contains
32        for details of the model.
33        List of default parameters:
34         radius_a        = 20.0 A
35         radius_b        = 400.0 A
36
37    """
38       
39    def __init__(self):
40        """ Initialization """
41       
42        # Initialize BaseComponent first, then sphere
43        BaseComponent.__init__(self)
44        CDiamEllipFunc.__init__(self)
45       
46        ## Name of the model
47        self.name = "DiamEllipFunc"
48        ## Model description
49        self.description ="""To calculate the 2nd virial coefficient for
50                the non-spherical object, then find the
51                radius of sphere that has this value of
52                virial coefficient:
53                radius_a = polar radius,
54                radius_b = equatorial radius;
55                radius_a > radius_b: Prolate spheroid,
56                radius_a < radius_b: Oblate spheroid."""
57       
58                ## Parameter details [units, min, max]
59        self.details = {}
60        self.details['radius_a'] = ['A', None, None]
61        self.details['radius_b'] = ['A', None, None]
62
63                ## fittable parameters
64        self.fixed=['radius_a.width', 'radius_b.width']
65   
66    def clone(self):
67        """ Return a identical copy of self """
68        return self._clone(DiamEllipFunc())   
69   
70    def run(self, x = 0.0):
71        """ Evaluate the model
72            @param x: input q, or [q,phi]
73            @return: scattering function P(q)
74        """
75       
76        return CDiamEllipFunc.run(self, x)
77   
78    def runXY(self, x = 0.0):
79        """ Evaluate the model in cartesian coordinates
80            @param x: input q, or [qx, qy]
81            @return: scattering function P(q)
82        """
83       
84        return CDiamEllipFunc.runXY(self, x)
85       
86    def set_dispersion(self, parameter, dispersion):
87        """
88            Set the dispersion object for a model parameter
89            @param parameter: name of the parameter [string]
90            @dispersion: dispersion object of type DispersionModel
91        """
92        return CDiamEllipFunc.set_dispersion(self, parameter, dispersion.cdisp)
93       
94   
95# End of file
Note: See TracBrowser for help on using the repository browser.