whm Module

Initial G*mass of the central body

Central mass gravitational term G * mass (units GU * MU)

Unitless principal moments of inertia (I1, I2, I3) / (MR**2). Principal axis rotation assumed.

Initial angular momentum of the central body

Tidal quality factor

Initial radius of the central body

Acceleration due to post-Newtonian correction

Barycentric acceleration due to central body oblatenes

Barycentric acceleration due to central body oblatenes at beginning of step

Barycentric acceleration due to central body oblatenes at end of step

Barycentric acceleration due to central body oblatenes

Barycentric acceleration due to central body oblatenes at beginning of step

Barycentric acceleration due to central body oblatenes at end of step

Spherical Harmonics coefficients for the central body

Change in G*mass of the central body

Change in angular momentum of the central body

Change in the radius of the central body

Central body mass density - calculated internally (units MU / DU**3)

External identifier (unique)

An abstract class for a generic central body in a Swiftest simulation Particle metadata information

J2*R^2 term for central body

J4*R^4 term for central body

Tidal Love number

Central body mass (units MU)

Central body radius (units DU)

Barycentric position (units DU)

Body rotation vector in inertial coordinate frame (units rad / TU)

Body rotation phase about the rotation pole (0 to 1)

Tidal phase lag angle

Barycentric velocity (units DU / TU)

Deallocates all allocatables and resets all values to defaults

Read in central body initial conditions from an ASCII file

updates the central body rotation phase

I/O routine for writing out a single frame of time-series data for all bodies in the system in NetCDF format

Dump contents of particle information metadata to file

Energy lost from nbody_system due to collisions

Initial orbital energy

Energy gained from nbody_system due to escaped bodies

Mass of bodies that escaped the nbody_system (used for bookeeping)

Total nbody_system mass - used for barycentric coordinate conversion

Initial nbody_system mass

Angular momentum of bodies that escaped the nbody_system (used for bookeeping)

nbody_system orbital angular momentum vector

Initial orbital angular momentum

nbody_system rotational angular momentum vector

Initial rotational angular momentum vector

nbody_system angular momentum vector

Initial total angular momentum vector

nbody_system binding energy of all bodies

Binding energy of central body (usually orders of magnitude larger than the rest of the system, and therefore tracked seperately)

Initial gravitational binding energy

Central body data structure

Collision system object

Stores encounter history for later retrieval and saving to file

Stores encounter history for later retrieval and saving to file

nbody_system orbital kinetic energy

Initial orbital kinetic energy

nbody_system rotational kinetic energy

Initial rotational kinetic energy

True if this is the beginning of a step. This is used so that test particle steps can be calculated separately from massive bodies. Massive body variables are saved at half steps, and passed to the test particles

Flag to indicate that this is the first time to write to a file

Flag to indicate that this is the first pericenter passage

The current maximum particle id number

nbody_system potential energy due to oblateness of the central body

nbody_system potential energy

Initial potential energy

Massive body data structure

List of added bodies in mergers or collisions

Discarded massive body particle data structure

List of massive body-massive body collisions in a single step

List of massive body-massive body encounters in a single step

List of massive body-test particle collisions in a single step

List of massive body-test particle encounters in a single step

Integration current time

nbody_system total energy

Initial total energy (sum of all sources of energy tracked)

Test particle data structure

List of added bodies in mergers or collisions

Discarded test particle data structure

Finalizes the WHM nbody_system object - deallocates all allocatables

Checks whether or not the test particle coarrays need to be rebalanced.

Collects all the test particles from other images into the image #1 test particle system

Distributes test particles from image #1 out to all images.

Prints out out terminal output when display_style is set to COMPACT

Compute energy and momentum and print out the change with time

Deallocates all allocatables and resets all values to defaults. Acts as a base for a finalizer

Perform a discard step on the nbody_system

Displays helpful information about the run

Dump the state of the nbody_system to a file

Calculates the total nbody_system energy and momentum

Returns an array of all id values in use in the nbody_system

Validates the dump file to check whether the dump file initial conditions duplicate the last frame of the netcdf output.

Initialize the nbody_system from input files

Performs WHM-specific initilization steps, like calculating the Jacobi masses

Write a frame of input data from file

Compute the contribution to the total gravitational potential due solely to the oblateness of the central body

Read in a frame of input data from file

Read a header for an output frame in NetCDF format

Reads the initial conditions for an nbody system

Read in particle metadata from file

Rescales the nbody_system into a new set of units

Sets the value of msys from the masses of nbody_system bodies.

Advance the WHM nbody system forward in time by one step

Validate the numerical ids passed to the nbody_system and save the maximum value

Write a frame of input data from file

Write a header for an output frame in NetCDF format

Mass gravitational term G * mass (units GU * MU)

Unitless principal moments of inertia (I1, I2, I3) / (MR**2). Principal axis rotation assumed.

Tidal quality factor

Semimajor axis (pericentric distance for a parabolic orbit)

Acceleration due to post-Newtonian correction

Total heliocentric acceleration

Barycentric accelerations of bodies due to central body oblatenes

Tanngential component of acceleration of bodies due to tides

semimajor axis following perihelion passage

Mean anomaly

Longitude of ascending node

Body mass density - calculated internally (units MU / DU**3)

Eccentricity

Jacobi mass

Identifier

Inclination

Particle metadata information

Inverse heliocentric radius term (1/rh**3)

Third term of heliocentric acceleration

perihelion passage flag

Tidal Love number

Index array used to convert flattened the body-body comparison upper triangular matrix

Array of merger relationship structures that can account for multiple pairwise mergers in a single step

flag indicating whether body has merged with another this time step

Body should be discarded

flag indicating whether body is part of an encounter this time step

Run the current step as a first

Logical mask used to select a subset of bodies when performing certain operations (drift, kick, accel, etc.)

flag indicating whether this body is below the GMTINY cutoff value

Body mass (units MU)

G * (Mcb + [m])

Jacobi mu: GMcb * eta(i) / eta(i - 1)

Number of bodies

number of encounters with other planets this time step

number of bodies above the GMTINY limit

Number of body-body comparisons in the flattened upper triangular matrix

Number of body (all massive)-body (only those above GMTINY) comparisons in the flattened upper triangular matrix

number of encounters with test particles this time step

Argument of pericenter

perihelion distance

Body radius (units DU)

Barycentric position

Position at beginning of step

Critical radius for close encounters

Position at end of step

Heliocentric position

Body mass (units MU)

Body rotation vector in inertial coordinate frame (units rad / TU)

An integrator-specific status indicator

Tidal phase lag

Barycentric velocity

Velocity at beginning of step

Heliocentric velocity

Jacobi velocity

Jacobi position

Finalizes the WHM massive body object - deallocates all allocatables

Compute heliocentric accelerations of massive bodies

Acceleration term arising from the post-Newtonian correction

Compute direct cross (third) term heliocentric accelerations of massive bodies

Compute the barycentric accelerations of bodies due to the oblateness of the central body

Add user-supplied heliocentric accelerations to planets

Appends elements from one structure to another

Convert massive bodies from barycentric to heliocentric coordinates (position and velocity)

Deallocates all allocatable arrays

Placeholder method for discarding massive bodies

Loop through massive bodies and call Danby drift routine to jacobi coordinates

Convert orbital elements to position and velocity vectors

“Fills” bodies from one object into another depending on the results of a mask (uses the UNPACK intrinsic)

Sets up the (i, j) -> k indexing used for the single-loop blocking Euclidean distance matrix

Determine nbody_system pericenter passages for test particles

Position kick due to p**4 term in the post-Newtonian correction

Convert massive bodies from heliocentric to barycentric coordinates (position and velocity)

Convert position and velcoity vectors from heliocentric to Jacobi coordinates

Convert position and velcoity vectors from Jacobi to helliocentric coordinates

Kick heliocentric velocities of massive bodies

Make impactors out of the current kinship relationships

Converts from psudeovelocity to velocity for GR calculations using symplectic integrators

Add the generic read frame for Fortran binary files

I/O routine for writing out a single frame of time-series data for the central body

Read in body initial conditions from an ascii file

Rearranges the order of array elements of body based on an input index array. Used in sorting methods

Clean up the massive body structures to remove discarded bodies and add new bodies

Resets the kinship status of bodies

Checks the current size of a Swiftest body against the requested size and resizes it if it is too small.

Convert massive bodies from heliocentric to barycentric coordinates (position only)

Saves a snapshot of the this body to the collision storage object

Sets the beginning and ending positions and velocities of planets.

Sets both the heliocentric and jacobi inverse radius terms (1/rj3 and 1/rh3)

Sets the Jacobi mass value for all massive bodies.

Sets the critical radius for encounter given an input real scale factor

Sets the critical radius for encounter given an inpput integer scale factor

Calculates the Hill’s radii for each body

Constructor method - Allocates space for the input number of bodiess

Sort a WHM massive body object in-place.

“Spills” bodies from one object to another depending on the results of a mask (uses the PACK intrinsic)

Steps the body forward one stepsize

Converts from velocity to psudeovelocity for GR calculations using symplectic integrators

Convert massive bodies from barycentric to heliocentric coordinates (velocity only)

Convert massive bodies from heliocentric to barycentric coordinates (velocity only)

Convert velocity vectors from heliocentric to Jacobi coordinates

I/O routine for writing out a single frame of time-series data for all bodies in the nbody_system in NetCDF format

Dump contents of particle information metadata to file

Convert position and velocity vectors to orbital elements

Semimajor axis (pericentric distance for a parabolic orbit)

Acceleration due to post-Newtonian correction

Total heliocentric acceleration

Barycentric accelerations of bodies due to central body oblatenes

Tanngential component of acceleration of bodies due to tides

semimajor axis following perihelion passage

Mean anomaly

Longitude of ascending node

Eccentricity

Identifier

Inclination

Particle metadata information

Inverse heliocentric radius term (1/rh**3)

perihelion passage flag

Index array used to convert flattened the body-body comparison upper triangular matrix

flag indicating whether body has merged with another this time step

Body should be discarded

flag indicating whether body is part of an encounter this time step

Run the current step as a first

Logical mask used to select a subset of bodies when performing certain operations (drift, kick, accel, etc.)

G * (Mcb + [m])

Number of bodies

number of encounters with planets this time step

Number of pl-tp comparisons in the flattened upper triangular matrix

Argument of pericenter

perihelion distance

Barycentric position

Heliocentric position

An integrator-specific status indicator

Barycentric velocity

Heliocentric velocity

Finalizes the WHM test particle object - deallocates all allocatables

Compute heliocentric accelerations of test particles

Acceleration term arising from the post-Newtonian correction

Compute direct cross (third) term heliocentric accelerations of test particles by massive bodies

Compute the barycentric accelerations of bodies due to the oblateness of the central body

Add user-supplied heliocentric accelerations to planets

Appends elements from one structure to another

Convert test particles from barycentric to heliocentric coordinates (position and velocity)

Deallocates all allocatable arrays

Check to see if test particles should be discarded based on their positions relative to the massive bodies

Loop through bodies and call Danby drift routine on heliocentric variables

Convert orbital elements to position and velocity vectors

“Fills” bodies from one object into another depending on the results of a mask (uses the UNPACK intrinsic)

Determine nbody_system pericenter passages for test particles

Position kick due to p**4 term in the post-Newtonian correction

Convert test particles from heliocentric to barycentric coordinates (position and velocity)

Kick heliocentric velocities of test particles

Converts from psudeovelocity to velocity for GR calculations using symplectic integrators

Add the generic read frame for Fortran binary files

I/O routine for writing out a single frame of time-series data for the central body

Read in body initial conditions from an ascii file

Rearranges the order of array elements of body based on an input index array. Used in sorting methods

Clean up the test particle structures to remove discarded bodies

Checks the current size of a Swiftest body against the requested size and resizes it if it is too small.

Convert test particles from heliocentric to barycentric coordinates (position only)

Saves a snapshot of the this body to the collision storage object

Sets the inverse heliocentric radius term (1/rh**3)

Method used to construct the vectorized form of the central body mass

A base constructor that sets the number of bodies and

Sorts body arrays by a sortable component

“Spills” bodies from one object to another depending on the results of a mask (uses the PACK intrinsic)

Steps the particle forward one stepsize

Converts from velocity to psudeovelocity for GR calculations using symplectic integrators

Convert test particles from barycentric to heliocentric coordinates (velocity only)

Convert test particles from heliocentric to barycentric coordinates (velocity only)

I/O routine for writing out a single frame of time-series data for all bodies in the nbody_system in NetCDF format

Dump contents of particle information metadata to file

Convert position and velocity vectors to orbital elements

WHM tp object

Swiftest body object

WHM massive body object

WHM nbody system object

WHM test particle object