Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

Norrery
Nbackend
CCpuFeatures	The instruction set extensions this project can make use of
CDeviceDescription	What the runtime reports about a device, in types that do not require SYCL
CExecutor	Something that can run a loop body over a range, possibly in parallel
CExecutorStatistics	The whole pool's record
CIndexRange	A half-open range of indices
CLogicalProcessor	One logical processor, as the operating system numbers them
CPaddedWorkerStatistics	One worker's record, on a cache line of its own
CSerialExecutor	Runs the whole range on the calling thread
CStaticExecutor	Divides the range into equal shares once and does not revisit the decision
CThreadPool	Worker threads and a way to run something on all of them at once
CUsmArray	An owning, movable, cache-line-aligned shared USM allocation
CWorkerStatistics	One worker's record, accumulated over every region since the last reset
CWorkStealingExecutor	Divides the range into equal shares and lets idle workers take from busy ones
Ncore
CAlignedAllocator	A standard allocator that returns cache-line-aligned storage
CDiagnostics	Every conserved quantity of a configuration, measured at one instant
CFunctionRef
CFunctionRef< Result(Args...)>	A reference to a callable taking Args and returning Result
CParticleData	Storage for a set of point masses in structure-of-arrays layout
CRandomSource	A seeded stream of random numbers
CSoftening	The softening length of the Plummer kernel above
CVec3	A vector in three-dimensional Euclidean space
CVec3Array	A resizable array of 3-vectors in component-array layout
CVec3Span	A view of three component arrays of equal length
Ninitial_conditions
CDiscGalaxyParameters	A disc galaxy to sample
CGalaxyCollisionParameters	An encounter between two disc galaxies
CKeplerParameters	A bound two-body orbit, described by its elements
CPlummerParameters	A Plummer sphere to sample
CUniformSphereParameters	A sphere of uniform density to sample
Nintegrators
CAccelerationField	The acceleration produced by a set of masses at a set of positions
CIntegrator	A method for advancing particle positions and velocities through time
CRungeKutta4	The classical fourth-order Runge-Kutta method
CVelocityVerlet	The second-order symplectic integrator described above
CYoshida4	The fourth-order symplectic composition described above
Nsim
CBinaryReader	Reads what BinaryWriter writes
CBinaryWriter	Writes the scalar types the formats in this layer are built from
CCheckpoint	A run, stopped
CConfiguration	A whole run, as data
CConfigurationError	A configuration file that could not be read as one
CDiagnosticsLog	Appends one row per measurement to a CSV file
CFileOutput	Writes the trajectory, the diagnostics and the checkpoints a configuration asks for
CInitialConditionSettings	What the run starts from
CIntegratorSettings
COutputSettings	What the run writes down, and how often
CRunOutput	Somewhere for a run to report itself to
CRunSettings	How far to go, and from what stream of random numbers
CSimulation	A gravitational simulation in progress
CSolverSettings	Which solver, and the parameters that decide what it computes
CTrajectoryFrame	One recorded instant
CTrajectoryInfo	What a trajectory file's header says about it
CTrajectoryReader	Reads the format above
CTrajectoryWriter	Writes the format above
Nsolvers
CBarnesHutSolver	The Barnes-Hut solver described above
CBoundingCube	The cube that encloses a configuration
CDirectSolver	The O(N^2) solver described above
CEvaluationTimings	Where the time of one force evaluation went
CForceSolver	A method for computing the gravitational acceleration of a set of particles
CInteractionCount	What a solver has done since the count was last reset
CMortonKey	One particle's place on the curve
CMortonOrdering	The particles of a configuration, in the order the tree wants them
COctree	The octree of one configuration, built from Morton-sorted particles
CQuadrupole	The traceless second moment of a cell about its centre of mass
CReferenceAcceleration	An acceleration in double precision, whatever the build's scalar type is
CSyclDirectSolver	Direct summation evaluated on a SYCL device
CSyclEvaluationTimings	Where the last evaluation spent its time
CSyclTreeSolver	Barnes-Hut with the traversal on a SYCL device
CSyclTreeTimings	Where one force evaluation spent its time
CTreeNode	One cell of the tree
CTreeParameters	The choices that decide what the tree costs and how accurate it is
CWalkCounts	What one walk did, in the two units InteractionCount reports
Nviz
CColour	A colour in linear light, before tone mapping
CGlFunctions	The entry points, as the pointers the driver returns
CImage	A rectangle of 8-bit RGB pixels, row-major from the top left
CMat4	A 4-by-4 transform in column-major order
COrbitCamera	A camera that orbits a point
CPointRenderer	The two-pass point renderer described above
CRenderSettings	Everything about how the picture looks that is not the camera
CToneMapping	The two numbers that decide how bright the picture is
CVec4	A point or direction in homogeneous coordinates
CViewerWindow	A window, its context, and an orbit camera the mouse drives
CWindowOptions	How the window is created