SMILE  v2.5
Schwarzschild Modelling Interactive expLoratory Environment
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
smile::CDensityExpDisk Class Reference

Exponential disk with several variants of vertical profile and spiral structure. More...

#include <potential.h>

Inheritance diagram for smile::CDensityExpDisk:
Inheritance graph
[legend]
Collaboration diagram for smile::CDensityExpDisk:
Collaboration graph
[legend]

Public Types

enum  EXPDISKTYPE { ED_EXP, ED_SECH2 }
 type of vertical density profile of exponential disk More...
 
- Public Types inherited from smile::CDensity
enum  POTENTIALTYPE {
  PT_UNKNOWN, PT_DIRECT, PT_COMPOSITE, PT_COEFS,
  PT_NB, PT_BSE, PT_BSECOMPACT, PT_SPLINE,
  PT_CYLSPLINE, PT_LOG, PT_HARMONIC, PT_SCALEFREE,
  PT_SCALEFREESH, PT_SPHERICAL, PT_DEHNEN, PT_MIYAMOTONAGAI,
  PT_FERRERS, PT_PLUMMER, PT_ISOCHRONE, PT_PERFECTELLIPSOID,
  PT_NFW, PT_SERSIC, PT_EXPDISK, PT_ELLIPSOIDAL,
  PT_MGE
}
 list of all existing types of density or density/potential models, each of them implemented in its own class More...
 
enum  SYMMETRYTYPE {
  ST_NONE = 0, ST_REFLECTION = 1, ST_PLANESYM = 2, ST_ZROTSYM = 4,
  ST_SPHSYM = 8, ST_TRIAXIAL = ST_REFLECTION | ST_PLANESYM, ST_AXISYMMETRIC = ST_TRIAXIAL | ST_ZROTSYM, ST_SPHERICAL = ST_AXISYMMETRIC | ST_SPHSYM,
  ST_DEFAULT = ST_TRIAXIAL
}
 Type of symmetry. More...
 

Public Member Functions

 CDensityExpDisk (double _mass, double _scaleR, double _scalez, EXPDISKTYPE _edtype)
 
virtual POTENTIALTYPE PotentialType () const
 enumerable potential type
 
virtual const char * PotentialName () const
 string representation of potential type
 
virtual SYMMETRYTYPE symmetry () const
 returns symmetry type of this potential
 
virtual double Rho (double X, double Y, double Z, double t=0) const
 returns density at given coordinates, this should obviously be overriden in derivative classes
 
virtual double getGamma () const
 returns inner density slope estimate (only used in BSE potential expansion for the automatic selection of shape parameter Alpha)
 
- Public Member Functions inherited from smile::CDensity
virtual double Mass (const double r) const
 returns mass inside given radius (approximately! not necessary to integrate density over sphere, just a rough estimate used e.g. in choosing radial nodes of Schwarzschild grid)
 
virtual double totalMass () const
 returns estimated M(r=infinity) or -1 if mass is infinite
 
double getRadiusByMass (const double m) const
 solves for Mass(r)=m
 
void getRadiiByMass (const vectord &masses, vectord *radii) const
 solves for Mass(r)=m for an array of sorted values of m (more efficient than doing it one-by-one)
 
bool checkMassMonotonic () const
 safety measure: check (roughly) that mass is increasing with radius
 
bool checkDensityNonzero () const
 another safety measure: check that density doesn't drop to zero along any of three axes (important to assess spherical-harmonic approximation quality)
 

Static Public Member Functions

static const char * myName ()
 

Private Attributes

const double mass
 total mass of the model
 
const double scaleR
 radial scale length
 
const double scalez
 vertical scale length
 
EXPDISKTYPE edtype
 type of vertical density profile
 

Detailed Description

Exponential disk with several variants of vertical profile and spiral structure.

Member Enumeration Documentation

type of vertical density profile of exponential disk

Enumerator
ED_EXP 

$ \rho(z) \propto 1/(2 z_0) \exp(-|z|/z_0) $

ED_SECH2 

$ \rho(z) \propto 1/(2 z_0) \mathrm{sech}^2(z/z_0) $


The documentation for this class was generated from the following files: