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

Schwarzschild data object to handle (rudimentary) kinematic data, in the form of radial and tangential velocity dispersions in a number of radial shells. More...

#include <schwarzschild.h>

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

Public Member Functions

 CSchwDataKinemShell (const CDensity *density, unsigned int _numShells, double innerShellMass, double outerShellMass, double betaIn, double betaOut)
 
virtual SCHWDATATYPE dataType () const
 descendant classes return their type
 
virtual std::string dataName () const
 string identificator of the class
 
virtual double getOrbitConstraint (size_t index, const CSchwInformation *info) const
 decode constraint value from an information object stored for a given orbit
 
virtual bool isSchwInformationCorrect (const CSchwInformation *info) const
 check compatibility of information object for an orbit with this data object
 
- Public Member Functions inherited from smile::CBasicShellSchwData
 CBasicShellSchwData (const CDensity *density, unsigned int _numShells, double innerShellMass, double outerShellMass)
 
virtual size_t numConstraints () const
 total number of constraints is the number of shells
 
virtual double getConstraint (size_t) const
 return the value of the given constraint
 
size_t whichShellR (double radius) const
 return index of shell in which a given radius lies, or shellRadius.size() if it is beyond the last shell
 
double getShellRadius (size_t index) const
 return the (outer) radius of a given shell
 
virtual double getConstraintNormFactor (size_t) const
 return a scaling coefficient which is used to normalize the penalty for constraint deviation in the optimization problem. More...
 

Static Public Member Functions

static const char * myName ()
 
- Static Public Member Functions inherited from smile::CBasicShellSchwData
static const char * myName ()
 

Private Attributes

vectord beta
 required values of vel.anisotr.coef in radial shells
 

Additional Inherited Members

- Public Types inherited from smile::CBasicSchwData
enum  SCHWDATATYPE {
  SD_UNKNOWN =0, SD_DENS =0x100, SD_KINEM =0x200, SD_DENS_SPATIAL_GRID =0x40,
  SD_DENS_SPHERICAL_HARMONIC =0x80, SD_DENS_GRIDCLASSIC =SD_DENS | SD_DENS_SPATIAL_GRID | 1, SD_DENS_GRIDCYLINDRICAL =SD_DENS | SD_DENS_SPATIAL_GRID | 2, SD_DENS_SHBSE =SD_DENS | SD_DENS_SPHERICAL_HARMONIC | 3,
  SD_DENS_SHMESH =SD_DENS | SD_DENS_SPHERICAL_HARMONIC | 4, SD_KINEM_SHELL =SD_KINEM| 1, SD_KINEM_ANGMOMDIST =SD_KINEM| 2
}
 Lists all possible variants of data objects. More...
 
- Protected Attributes inherited from smile::CBasicShellSchwData
double totalMass
 
vectord shellRadius
 radii of concentric shells for storing kinematic data
 

Detailed Description

Schwarzschild data object to handle (rudimentary) kinematic data, in the form of radial and tangential velocity dispersions in a number of radial shells.

For each orbit, the corresponding runtime function records the fraction of time that the orbit spends inside every shell, as well as the radial and tangential velocity dispersion in that shell. The class that does the actual Schwarzschild modelling takes this information and tries to achieve a given velocity anisotropy profile throughout the model; the actual value of anisotropy in a given shell is not specified at the time of orbit integration but rather is set at the modelling stage, therefore the "required" constraints are not used literally.


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