source: sasview/sansmodels/src/sans/models/HayterMSAStructure.py @ 8346667

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 8346667 was 1bbf2ac, checked in by Jae Cho <jhjcho@…>, 16 years ago

structure py models

  • 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:\ECLPS\workspace\trunk\sansmodels\src\sans\models\c_extensions\HayterMSA.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CHayterMSAStructure
26import copy   
27   
28class HayterMSAStructure(CHayterMSAStructure, BaseComponent):
29    """ Class that evaluates a HayterMSAStructure model.
30        This file was auto-generated from c:\ECLPS\workspace\trunk\sansmodels\src\sans\models\c_extensions\HayterMSA.h.
31        Refer to that file and the structure it contains
32        for details of the model.
33        List of default parameters:
34         radius          = 20.75 A
35         charge          = 19.0
36         volfraction     = 0.0192
37         temperature     = 318.16 K
38         saltconc        = 0.0
39         dielectconst    = 71.08
40
41    """
42       
43    def __init__(self):
44        """ Initialization """
45       
46        # Initialize BaseComponent first, then sphere
47        BaseComponent.__init__(self)
48        CHayterMSAStructure.__init__(self)
49       
50        ## Name of the model
51        self.name = "HayterMSAStructure"
52        ## Model description
53        self.description ="""To calculate the structure factor (the Fourier transform
54                of the pair correlation function g(r)) for
55                a system of charged, spheroidal objects in
56                a dielectric medium. When combined with an
57                appropriate form factor, this allows
58                for inclusion of the interparticle
59                interference effects due to screened coulomb
60                repulsion between charged particles.
61                (note: charge > 0 required.)
62               
63                Ref: JP Hansen and JB Hayter, Molecular
64                Physics 46, 651-656 (1982).
65                """
66       
67                ## Parameter details [units, min, max]
68        self.details = {}
69        self.details['radius'] = ['A', None, None]
70        self.details['charge'] = ['', None, None]
71        self.details['volfraction'] = ['', None, None]
72        self.details['temperature'] = ['K', None, None]
73        self.details['saltconc'] = ['', None, None]
74        self.details['dielectconst'] = ['', None, None]
75
76                ## fittable parameters
77        self.fixed=['radius.width']
78   
79    def clone(self):
80        """ Return a identical copy of self """
81        return self._clone(HayterMSAStructure())   
82   
83    def run(self, x = 0.0):
84        """ Evaluate the model
85            @param x: input q, or [q,phi]
86            @return: scattering function P(q)
87        """
88       
89        return CHayterMSAStructure.run(self, x)
90   
91    def runXY(self, x = 0.0):
92        """ Evaluate the model in cartesian coordinates
93            @param x: input q, or [qx, qy]
94            @return: scattering function P(q)
95        """
96       
97        return CHayterMSAStructure.runXY(self, x)
98       
99    def set_dispersion(self, parameter, dispersion):
100        """
101            Set the dispersion object for a model parameter
102            @param parameter: name of the parameter [string]
103            @dispersion: dispersion object of type DispersionModel
104        """
105        return CHayterMSAStructure.set_dispersion(self, parameter, dispersion.cdisp)
106       
107   
108# End of file
Note: See TracBrowser for help on using the repository browser.