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

Orbit filtering function based on whether an orbit belongs to a given energy shell. More...

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

Public Member Functions

 CShellOrbitFilteringFnc (const CSchwDataAngMomDist *_model, const CPotential *_potential, unsigned int _numShell)
 
virtual double eval (const COrbitDesc *orbit) const
 return 1 if the orbit is inside a given energy shell, 0 otherwise
 

Private Attributes

const CSchwDataAngMomDistmodel
 pointer to a shell-kinematic Schwarzschild data object from which the shell index for an orbit is determined
 
const CPotentialpotential
 pointer to the potential used in computing total energy of an orbit
 
unsigned int numShell
 required shell index
 

Detailed Description

Orbit filtering function based on whether an orbit belongs to a given energy shell.

Energy shells are taken from an existing shell-kinematic Schwarzschild data object. if model==NULL or numShell==0, any orbit is acceptable, otherwise only if orbit energy is within numShell-1 energy shell. Used in filtering displayed orbits on the frequency map or Schw.model tabs. TODO: eliminate the relation to Schw.data object! may use filtering by energy without any model.


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