__init__.doc.py File Reference

This is the documentation for libswarmng_ext, but because all the symbols from libswarmng_ext are included in the swarmng module we document it under swarmng package. More...

Go to the source code of this file.

Classes
class	swarmng.Config
	Specialization of std::map to hold all our configuration attributes. More...
class	swarmng.System
	A planetary system within an ensemble. More...
class	swarmng.System.Attribute
	Attributes of the system, it is just a list of floating point values. More...
class	swarmng.Body
	A body object within a system. More...
class	swarmng.Body.Components
	Representetive for one component (x,y,z) of the object Contains position and velocity for that component. More...
class	swarmng.Body.Attribute
	Attributes of the body, it is just a list of floating point values. More...
class	swarmng.Ensemble
	Abstract ensemble data structure. More...
class	swarmng.DefaultEnsemble
	The default implementation of ensemble data structor that stores data in system memory. More...
class	swarmng.Integrator
	An ODE integration algorithms. More...
class	swarmng.GpuIntegrator
	GPU accelerated integrator. More...

Namespaces
	swarmng
	Python interface to the Swarm-NG library.

Constant Groups
	swarmng
	Python interface to the Swarm-NG library.

Functions
def	swarmng.init
	Initialize the Swarm library, registering the GPU and Logging subsystem. More...
def	swarmng.generate_ensemble
	Generate an trivial ensemble with planets in circular orbits. More...
def	swarmng.sync
	Synchronize all CUDA kernels. More...
def	swarmng.calc_keplerian_for_cartesian
	Returns Keplerian coordinates (as a list) from position and velocity of a body in cartesian coordinates. More...
def	swarmng.calc_cartesian_for_keplerian
	Returns cartesian coordinates (position and velocity) of an object for the given Keplerian coordinates. More...
def	swarmng.find_max_energy_conservation_error
	Compare two ensembles and find the maximum of energy conservation error amongst systems. More...

Detailed Description

This is the documentation for libswarmng_ext, but because all the symbols from libswarmng_ext are included in the swarmng module we document it under swarmng package.

The implementation of all of these is in src/python/module.cpp but we have to separate the documentation and put it here.

To read the documentation generated from this file refer to swarmng

Definition in file __init__.doc.py.