source: sasview/sansmodels/src/sans/models/HardsphereStructure.py @ 18695bf

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 18695bf was 96656e3, checked in by Jae Cho <jhjcho@…>, 14 years ago

update models due to changes of template

  • Property mode set to 100644
File size: 4.6 KB
Line 
1#!/usr/bin/env python
2
3##############################################################################
4#       This software was developed by the University of Tennessee as part of the
5#       Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
6#       project funded by the US National Science Foundation.
7#
8#       If you use DANSE applications to do scientific research that leads to
9#       publication, we ask that you acknowledge the use of the software with the
10#       following sentence:
11#
12#       "This work benefited from DANSE software developed under NSF award DMR-0520547."
13#
14#       copyright 2008, University of Tennessee
15##############################################################################
16
17
18"""
19Provide functionality for a C extension model
20
21:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
22         DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\Hardsphere.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CHardsphereStructure
29import copy   
30
31def create_HardsphereStructure():
32    obj = HardsphereStructure()
33    #CHardsphereStructure.__init__(obj) is called by HardsphereStructure constructor
34    return obj
35
36class HardsphereStructure(CHardsphereStructure, BaseComponent):
37    """
38    Class that evaluates a HardsphereStructure model.
39    This file was auto-generated from ..\c_extensions\Hardsphere.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
43         effect_radius   = 50.0 [A]
44         volfraction     = 0.2
45
46    """
47       
48    def __init__(self):
49        """ Initialization """
50       
51        # Initialize BaseComponent first, then sphere
52        BaseComponent.__init__(self)
53        #apply(CHardsphereStructure.__init__, (self,))
54        CHardsphereStructure.__init__(self)
55       
56        ## Name of the model
57        self.name = "HardsphereStructure"
58        ## Model description
59        self.description ="""Structure factor for interacting particles:                   .
60               
61                The interparticle potential is
62               
63                U(r)= inf   , r < 2R
64                = 0     , r >= 2R
65               
66                R: effective radius of the Hardsphere particle
67                V:The volume fraction
68               
69                Ref: Percus., J. K.,etc., J. Phy.
70                Rev. 1958, 110, 1."""
71       
72        ## Parameter details [units, min, max]
73        self.details = {}
74        self.details['effect_radius'] = ['[A]', None, None]
75        self.details['volfraction'] = ['', None, None]
76
77        ## fittable parameters
78        self.fixed=['effect_radius.width']
79       
80        ## non-fittable parameters
81        self.non_fittable = []
82       
83        ## parameters with orientation
84        self.orientation_params = []
85   
86    def __reduce_ex__(self, proto):
87        """
88        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
89        c model.
90        """
91        return (create_HardsphereStructure,tuple())
92       
93    def clone(self):
94        """ Return a identical copy of self """
95        return self._clone(HardsphereStructure())   
96       
97   
98    def run(self, x=0.0):
99        """
100        Evaluate the model
101       
102        :param x: input q, or [q,phi]
103       
104        :return: scattering function P(q)
105       
106        """
107       
108        return CHardsphereStructure.run(self, x)
109   
110    def runXY(self, x=0.0):
111        """
112        Evaluate the model in cartesian coordinates
113       
114        :param x: input q, or [qx, qy]
115       
116        :return: scattering function P(q)
117       
118        """
119       
120        return CHardsphereStructure.runXY(self, x)
121       
122    def evalDistribution(self, x=[]):
123        """
124        Evaluate the model in cartesian coordinates
125       
126        :param x: input q[], or [qx[], qy[]]
127       
128        :return: scattering function P(q[])
129       
130        """
131        return CHardsphereStructure.evalDistribution(self, x)
132       
133    def calculate_ER(self):
134        """
135        Calculate the effective radius for P(q)*S(q)
136       
137        :return: the value of the effective radius
138       
139        """       
140        return CHardsphereStructure.calculate_ER(self)
141       
142    def set_dispersion(self, parameter, dispersion):
143        """
144        Set the dispersion object for a model parameter
145       
146        :param parameter: name of the parameter [string]
147        :param dispersion: dispersion object of type DispersionModel
148       
149        """
150        return CHardsphereStructure.set_dispersion(self, parameter, dispersion.cdisp)
151       
152   
153# End of file
Note: See TracBrowser for help on using the repository browser.