smile::CBasicICGenerator Class Reference

Base class for creating initial conditions for orbit library. More...

#include <icgenerator.h>

Inheritance diagram for smile::CBasicICGenerator:

Public Types
enum	ICTYPE {   IC_E_STATIONARY, IC_E_PRINCIPALPLANE, IC_E_YALPHA, IC_E_RANDOM,   IC_DENS_SAMPLER, IC_DENS_ELLIPSOIDAL, IC_VEL_EDDINGTON, IC_VEL_JEANSSPH,   IC_VEL_JEANSAXI }
	list all possible types of descendant classes More...

Public Member Functions
virtual void	createInitialConditions (size_t numPoints, CPointMassSet< float > *points)=0
	Create a desired number of points and add them to the point mass set. More...

Detailed Description

Base class for creating initial conditions for orbit library.

The output consists of starting points and optionally the priors on orbit weights (if used for Schwarzschild modelling) stored in a point mass set.

Member Enumeration Documentation

enum smile::CBasicICGenerator::ICTYPE

list all possible types of descendant classes

Enumerator
IC_E_STATIONARY	CICGeneratorStationary.
IC_E_PRINCIPALPLANE	CICGeneratorPrincipalPlane.
IC_E_YALPHA	CICGeneratorYalpha.
IC_E_RANDOM	CICGeneratorRandomE.
IC_DENS_SAMPLER	CICGeneratorDensitySampler.
IC_DENS_ELLIPSOIDAL	CICGeneratorDensityEllipsoidal.
IC_VEL_EDDINGTON	CICGeneratorVelocityEddington.
IC_VEL_JEANSSPH	CICGeneratorVelocityJeansSph.
IC_VEL_JEANSAXI	CICGeneratorVelocityJeansAxi.

Member Function Documentation

virtual void smile::CBasicICGenerator::createInitialConditions ( size_t  numPoints, CPointMassSet< float > *  points  )

pure virtual

Create a desired number of points and add them to the point mass set.

Parameters

[in]	numPoints	is the requested number of points; the actual output may slightly differ
[in,out]	points	is the pointer to the array that will contain the points. For the IC velocity generators, this array should already contain positions of particles, and only the velocities will be initialized.

Implemented in smile::CICGeneratorSchw, smile::CICGeneratorVelocityJeansAxi, smile::CICGeneratorVelocityJeansSph, smile::CICGeneratorVelocityEddington, smile::CICGeneratorDensityEllipsoidal, smile::CICGeneratorDensitySampler, smile::CICGeneratorDensitySpherical, smile::CICGeneratorRandomE, smile::CICGeneratorYalpha, smile::CICGeneratorPrincipalPlane, and smile::CICGeneratorStationary.

---

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

• icgenerator.h