GravitationPotential Class Reference

a function describing the gravitational potential of a spherical mass More...

#include <RealFunctionImplementations.h>

Inheritance diagram for GravitationPotential:

Collaboration diagram for GravitationPotential:

List of all members.

Classes
class	DefiningFunction
	ParametricFunction that defines GravitationPotential. More...
Public Member Functions
	GravitationPotential (double tmin, double tmax, double dt, double umin, double umax, double du, double vmin, double vmax, double dv, double M=1, double R=0.25)
virtual std::string	getFunctionName () const
virtual void	SetParameters (const ParameterMap &parms)
	Set parameters to the Displayable.
Protected Attributes
double	_M
	Mass of the generating sphere(not really M, but M/R^3)
double	_R
	Radius of the generating sphere.

---

Detailed Description

a function describing the gravitational potential of a spherical mass

---

Constructor & Destructor Documentation

GravitationPotential::GravitationPotential	(	double	xmin,
		double	xmax,
		double	dx,
		double	ymin,
		double	ymax,
		double	dy,
		double	zmin,
		double	zmax,
		double	dz,
		double	M = 1,
		double	R = 0.25
	)

GravitationPotential c'tor given a definition set in (as parameter space), a mass and a radius of a spherical mass

Parameters:

xmin	minimal value in t
xmax	maximal value in t
dx	stepsize in t
ymin	minimal value in u
ymax	maximal value in u
dy	stepsize in u
zmin	minimal value in v
zmax	maximal value in v
dz	stepsize in v
M	Mass of the generating sphere
R	Radius of the generating sphere

References RealFunction::_function, Displayable::declareParameter(), and RealFunction::Initialize().

Here is the call graph for this function:

---

Member Function Documentation

virtual std::string GravitationPotential::getFunctionName

(

)

const [inline, virtual]

Returns:

The name of the function in cleartext

Reimplemented from RealFunction.

virtual void GravitationPotential::SetParameters

(

const ParameterMap &

)

[inline, virtual]

Set parameters to the Displayable.

Todo:

This function is only there to provide an interface, and it's not abstract so that Displayable s which don't have Parameters don't need to reimplement an unneeded method. But the present implementation does not make sense.

Reimplemented from Displayable.

References _M, _R, std::map< _Key, _Tp, _Compare, _Alloc >::begin(), std::map< _Key, _Tp, _Compare, _Alloc >::end(), and Displayable::setParameter().

Here is the call graph for this function:

---

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

• HyperspaceExplorer/src/Displayable/RealFunctionImplementations.h
• HyperspaceExplorer/src/Displayable/RealFunctionImplementations.cpp