source: sasview/src/sas/models/include/spheroid.h @ c93122e

#if !defined(spheroid_h)
#define spheroid_h
#include "parameters.hh"

/** Structure definition for oblate parameters
 * [PYTHONCLASS] = CoreShellEllipsoidModel
 * [DISP_PARAMS] = equat_core, polar_core, equat_shell,polar_shell,axis_phi, axis_theta
   [DESCRIPTION] = <text>[SpheroidCoreShellModel] Calculates the form factor for an spheroid
                        ellipsoid particle with a core_shell structure.
                        The form factor is averaged over all possible
                        orientations of the ellipsoid such that P(q)
                        = scale*<f^2>/Vol + bkg, where f is the
                        single particle scattering amplitude.
                        [Parameters]:
                        equat_core = equatorial radius of core,
                        polar_core = polar radius of core,
                        equat_shell = equatorial radius of shell,
                        polar_shell = polar radius (revolution axis) of shell,
                        sld_core = SLD_core
                        sld_shell = SLD_shell
                        sld_solvent = SLD_solvent
                        background = Incoherent bkg
                        scale =scale
                        Note:It is the users' responsibility to ensure
                        that shell radii are larger than core radii.
                        oblate: polar radius < equatorial radius
                        prolate :  polar radius > equatorial radius
                        </text>

   [FIXED] = <text>equat_core.width;polar_core.width; equat_shell.width; polar_shell.width; axis_phi.width; axis_theta.width</text>
   [ORIENTATION_PARAMS]= <text>axis_phi; axis_theta; axis_phi.width; axis_theta.width</text>

 **/

class CoreShellEllipsoidModel{
public:
  // Model parameters
  /// Scale factor
  //  [DEFAULT]=scale=1.0
  Parameter scale;
  /// Equatorial radius of core [A]
  //  [DEFAULT]=equat_core=200.0 [A]
  Parameter equat_core;
  /// Polar radius of core [A]
  //  [DEFAULT]=polar_core=20.0 [A]
  Parameter polar_core;
  /// equatorial radius of shell [A]
  //  [DEFAULT]=equat_shell=250.0 [A]
  Parameter equat_shell;
  /// polar radius of shell [A]
  //  [DEFAULT]=polar_shell=30.0 [A]
  Parameter polar_shell;
  ///  Core scattering length density [1/A^(2)]
  //  [DEFAULT]=sld_core=2.0e-6 [1/A^(2)]
  Parameter sld_core;
  ///  Shell scattering length density [1/A^(2)]
  //  [DEFAULT]=sld_shell=1.0e-6 [1/A^(2)]
  Parameter sld_shell;
  /// Solvent scattering length density  [1/A^(2)]
  //  [DEFAULT]=sld_solvent=6.3e-6 [1/A^(2)]
  Parameter sld_solvent;
  /// Incoherent Background [1/cm] 0.001
  //  [DEFAULT]=background=0.001 [1/cm]
  Parameter background;
  //Disable for now
  /// Orientation of the oblate axis w/respect incoming beam [deg]
  //  [DEFAULT]=axis_theta=0.0 [deg]
  Parameter axis_theta;
  /// Orientation of the oblate in the plane of the detector [deg]
  //  [DEFAULT]=axis_phi=0.0 [deg]
  Parameter axis_phi;

  // Constructor
  CoreShellEllipsoidModel();

  // Operators to get I(Q)
  double operator()(double q);
  double operator()(double qx, double qy);
  double calculate_ER();
  double calculate_VR();
  double evaluate_rphi(double q, double phi);
};

#endif