Base class for storing kinematic information on a radial grid. More...

#include <schwarzschild.h>

Inheritance diagram for smile::CBasicShellSchwData:

Collaboration diagram for smile::CBasicShellSchwData:

Public Member Functions
	CBasicShellSchwData (const CDensity *density, unsigned int _numShells, double innerShellMass, double outerShellMass)

virtual SCHWDATATYPE	dataType () const
	descendant classes return their type

virtual std::string	dataName () const
	string identificator of the class

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...

Public Member Functions inherited from smile::CBasicSchwData
virtual double	getOrbitConstraint (size_t index, const CSchwInformation *info) const =0
	decode constraint value from an information object stored for a given orbit

virtual bool	isSchwInformationCorrect (const CSchwInformation *info) const =0
	check compatibility of information object for an orbit with this data object

Static Public Member Functions
static const char *	myName ()

Protected Attributes
double	totalMass

vectord	shellRadius
	radii of concentric shells for storing kinematic data

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...

Detailed Description

Base class for storing kinematic information on a radial grid.

Member Function Documentation

virtual double smile::CBasicShellSchwData::getConstraintNormFactor ( size_t ) const

inlinevirtual

return a scaling coefficient which is used to normalize the penalty for constraint deviation in the optimization problem.

Introduced to make the optimization problem more uniformly scaled (//optional, by default returns 1)

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