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

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 e2f7b92 was f9bf661, checked in by Jae Cho <jhjcho@…>, 15 years ago

updated documents

  • Property mode set to 100644
File size: 3.8 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_extensions\Hardsphere.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CHardsphereStructure
26import copy   
27   
28class HardsphereStructure(CHardsphereStructure, BaseComponent):
29    """ Class that evaluates a HardsphereStructure model.
30        This file was auto-generated from ..\c_extensions\Hardsphere.h.
31        Refer to that file and the structure it contains
32        for details of the model.
33        List of default parameters:
34         effect_radius   = 50.0 [A]
35         volfraction     = 0.2
36
37    """
38       
39    def __init__(self):
40        """ Initialization """
41       
42        # Initialize BaseComponent first, then sphere
43        BaseComponent.__init__(self)
44        CHardsphereStructure.__init__(self)
45       
46        ## Name of the model
47        self.name = "HardsphereStructure"
48        ## Model description
49        self.description ="""Structure factor for interacting particles:                   .
50               
51                The interparticle potential is
52               
53                U(r)= inf   , r < 2R
54                = 0     , r >= 2R
55               
56                R: effective radius of the Hardsphere particle
57                V:The volume fraction
58               
59                Ref: Percus., J. K.,etc., J. Phy.
60                Rev. 1958, 110, 1."""
61       
62                ## Parameter details [units, min, max]
63        self.details = {}
64        self.details['effect_radius'] = ['[A]', None, None]
65        self.details['volfraction'] = ['', None, None]
66
67                ## fittable parameters
68        self.fixed=['effect_radius.width']
69       
70        ## parameters with orientation
71        self.orientation_params =[]
72   
73    def clone(self):
74        """ Return a identical copy of self """
75        return self._clone(HardsphereStructure())   
76   
77    def run(self, x = 0.0):
78        """ Evaluate the model
79            @param x: input q, or [q,phi]
80            @return: scattering function P(q)
81        """
82       
83        return CHardsphereStructure.run(self, x)
84   
85    def runXY(self, x = 0.0):
86        """ Evaluate the model in cartesian coordinates
87            @param x: input q, or [qx, qy]
88            @return: scattering function P(q)
89        """
90       
91        return CHardsphereStructure.runXY(self, x)
92       
93    def evalDistribition(self, x = []):
94        """ Evaluate the model in cartesian coordinates
95            @param x: input q[], or [qx[], qy[]]
96            @return: scattering function P(q[])
97        """
98        return CHardsphereStructure.evalDistribition(self, x)
99       
100    def calculate_ER(self):
101        """ Calculate the effective radius for P(q)*S(q)
102            @return: the value of the effective radius
103        """       
104        return CHardsphereStructure.calculate_ER(self)
105       
106    def set_dispersion(self, parameter, dispersion):
107        """
108            Set the dispersion object for a model parameter
109            @param parameter: name of the parameter [string]
110            @dispersion: dispersion object of type DispersionModel
111        """
112        return CHardsphereStructure.set_dispersion(self, parameter, dispersion.cdisp)
113       
114   
115# End of file
Note: See TracBrowser for help on using the repository browser.