icgenerator.h File Reference

Classes for generating the initial conditions for the orbit library. More...

#include "common.h"

Include dependency graph for icgenerator.h:

This graph shows which files directly or indirectly include this file:

Classes
class	smile::CBasicICGenerator
	Base class for creating initial conditions for orbit library. More...
class	smile::CICGeneratorStationary
	Initial conditions from stationary start space. More...
class	smile::CICGeneratorPrincipalPlane
	Initial conditions from principal-plane start space. More...
class	smile::CICGeneratorYalpha
	Initial conditions from Y-alpha start space. More...
class	smile::CICGeneratorRandomE
	Initial conditions from random start space at given energy. More...
class	smile::CICGeneratorDensitySpherical
	sample points from a spherical mass model More...
class	smile::CICGeneratorDensitySampler
	sample points coordinates proportionally to local density, no velocities assigned More...
class	smile::CICGeneratorDensityEllipsoidal
	sample point coordinates using ellipsoidal equidensity surface approximation; this method is generally inferior to CICGeneratorDensitySampler More...
class	smile::CICGeneratorVelocityEddington
	sample velocities from the Eddington distribution function for equivalent spherical system More...
class	smile::CICGeneratorVelocityJeansSph
	sample velocities from the spherical Jeans equation More...
class	smile::CICGeneratorVelocityJeansAxi
	sample velocities from Jeans equation for an axisymmetric system More...
class	smile::CICGeneratorSchw
	class that combines two samplers – for positions and velocities More...

Namespaces
	smile
	common namespace for all core SMILE classes, functions and variables

Functions
--- non-class utility routines ---
const char *	smile::getICgenNameByType (CBasicICGenerator::ICTYPE ICType)
	return the name for a given IC generator data type
CBasicICGenerator::ICTYPE	smile::getICgenTypeByName (const std::string &ICName)
	return IC generator data type associated with the text name

Detailed Description

Classes for generating the initial conditions for the orbit library.

Author

EV

Date

2009-2014

This file contains the family of classes that are used to create initial conditions for orbit library (frequency map or Schwarzschild model). All descendants of the base class CBasicICGenerator provide a virtual function to create a necessary number of points, and output them as a CPointMassSet.

There are three kinds of IC generators: one family is intended to construct IC for frequency map, i.e. for a given value of energy. The other two are for the entire range of energies, used in the context of Schwarzschild modelling. They are further divided into position generators and velocity generators; fundamentally, the first ones sample points from the density profile of the model, with zero velocities, and the second ones assign velocities for already existing positions. Furthermore, CICGeneratorSchw class combines these two aspects (taking an instance of each class).