ringmoons 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)

negative barycentric velocity of the central body at the beginning of time step

negative barycentric velocity of the central body at the end of time step

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 recursion level

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

Ringmoons ring object

Ringmoons seed object

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

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

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 ringmoons-specific initilization steps

Write a frame of input data from file

Perform an interpolation step on the SymBA nbody system

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

Step interacting planets and active test particles ahead in democratic heliocentric coordinates at the current recursion level, if applicable, and descend to the next deeper level if necessary

Rescales the nbody_system into a new set of units

Resets pl, tp,and encounter structures at the start of a new step

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

Sets recursion levels of bodies and encounter lists to the current nbody_system level

Advance the ringmoons 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

ID for the system binding energy variable

ID for the energy lost in collisions variable

name of the escaped angular momentum y variable

ID for the energy that is untracked due to loss (due to mergers and body energy for escaped bodies)

name of the energy that is untracked due to loss (due to mergers and body energy for escaped bodies)

ID for the G*Mass of bodies that escape the system

name of the G*Mass of bodies that escape the system

ID for the G*mass variable

name of the G*mass variable

ID for the axis principal moment of inertia variable

name of the principal moment of inertial variable

ID for the system orbital kinetic energy variable

ID for the system rotational kinetic energy variable

ID for the escaped angular momentum vector variable

name of the escaped angular momentum vector variable

ID for the system orbital angular momentum vector variable

name of the orbital angular momentum vector variable

ID for the system rotational angular momentum vector variable

name of the rotational angular momentum vector variable

ID for the system potential energy variable

ID for the energy dissipation variable

ID for the system binding energy variable

ID for the Y_21 yarkovsky directional variable

name of the Y_21 yarkovsky directional variable

ID for the planet’s semi-major axis from the sun variable

name of the planet’s semi-major axis from the sun variable

ID for the semimajor axis variable

name of the semimajor axis variable

ID for the albedo variable

name of the albedo variable

name of the system binding energy variable

ID for the c_lm aqrray

name for the c_lm array

ID for the eccentric/hyperbolic anomaly variable

name of the eccentric/hyperbolic anomaly variable

ID for the mean anomaly variable

name of the mean anomaly variable

ID for the long. asc. node variable

name of the long. asc. node variable

name of the collision id variable

Netcdf ID for the origin collision ID

ID for the planetary shadow width variable

name of the planetary shadow with variable

ID for the id of the other body involved in the discard

name of the id of the other body involved in the discard

ID for the heliocentric position vector of the body at the time of discard variable

name of the heliocentric position vector of the body at the time of discard variable

ID for the time of discard variable

name of the time of discard variable

ID for the heliocentric velocity vector of the body at the time of discard variable

name of the heliocentric velocity vector of the body at the time of discard variable

ID for the eccentricity variable

name of the eccentricity variable

ID for the emissivity variable

name of the emissivity variable

ID for the true anomaly variable

name of the true anomaly variable

Name of the output file

ID for the thermal inertia parameter for yarkovsky effects

name of the thermal inertia parameter for yarkovsky effects

ID for the heliocentric pseudovelocity vector variable (used in GR)

name of the heliocentric pseudovelocity vector variable (GR)

ID for the output file

ID for the id variable

name of the particle id variable

The current id slot that gets passed to the NetCDF reader/writer

Array of id values in this NetCDF file

ID for the inclination variable

name of the inclination variable

ID for the j2 variable

name of the j2rp2 variable

ID for the j4 variable

name of the j4pr4 variable

ID for the Love number variable

name of the Love number variable

name of the system orbital kinetic energy variable

name of the system rotational kinetic energy variable

Maximum value of the l dimension

ID for the l dimension for c_lm

name of l dimension for c_lm

ID for the l variable

ID for the mean longitude variable

name of the mean longitude variable

Logical flag to indicate whether or not the c_lm array was present in an old file.

Flag indicating that the linked file is currently open

Logical flag to indicate whether or not the pseudovelocity vectors were present in an old file.

Maximum value of the m dimension

ID for the m dimension for c_lm

name of m dimension for c_lm

ID for the ring particle mass per bin variable

name of the ring particle mass per bin variable

ID for the m variable

ID for the mass variable

name of the mass variable

Records the last index value of id in the NetCDF file

Records the last index value of time in the NetCDF file

ID for the particle name dimension

name of the particle name dimension

ID for the particle name variable

Number of elements in the ring bins

ID for the number of active massive bodies variable

name of the number of active massive bodies variable

ID for the number of active fully interacting massive bodies variable (SyMBA)

name of the number of active fully interacting massive bodies variable (SyMBA)

ID for the number of active seeds (Ringmoons)

name of the number of active seeds (Ringmoons)

ID for the number of active test particles variable

name of the number of active test particles variable

ID for the viscosity of the ring bin variable

name of the viscosity of the ring bin variable

ID for the obliquity variable

name of the obliquity variable

ID for the arg. of periapsis variable

name of the arg. of periapsis variable

ID for the origin position vector variable

name of the heliocentric position vector of the body at the time of origin variable

ID for the origin time

name of the time of origin variable

ID for the origin type

name of the origin type variable

ID for the origin velocity vector component

name of the heliocentric velocity vector of the body at the time of origin variable

output type (will be assigned either NF90_DOUBLE or NF90_FLOAT, depending on the user parameter)

name of the system potential energy variable

ID for the particle type variable

name of the particle type variable

name of the energy dissipation variable

ID for the inside radius of ring variable

name of the inside radius of ring variable

ID for the outside radius of ring variable

name of the outside radius of ring variable

ID for the ring particle radius per bin variable

name of the ring particle radius per bin variable

ID for the radial distance of bin center variable

name of the radial distance of bin center variable

ID for the radius variable

name of the radius variable

ID for the heliocentric position vector variable

name of the heliocentric position vector variable

ID for the hill radius variable

name of the hill radius variable

ID for the ring bin dimension

name of the ring bin dimension

ID for the ring bin variable

ID for the rotational constant k for yarkovsky effects

name of the rotational constant k for yarkovsky effects

ID for the rotation vector variable

name of the rotation vector variable

ID for the rotation phase variable

name of the rotation phase variable

ID for the surface mass density of ring bin variable

name of the surface mass density of ring bin variable

The sign dimension coordinate labels

ID for sign dimension

name of the sign dimension for c_lm

ID for sign variable

The space dimension coordinate labels

ID for the space dimension

name of the space dimension

ID for the space variable

ID for the status variable

name of the particle status variable

ID for the character string dimension

name of the character string dimension

ID for the ring optical depth variable

name of the ring optical depth variable

name of the system binding energy variable

ID for the time dimension

name of the time dimension

ID for the time variable

ID for the Toomre parameter of the ring bin variable

name of the Toomre parameter of the ring bin variable

The current time slot that gets passed to the NetCDF reader/writer

ID for the long. of periapsis variable

name of the long. of periapsis variable

ID for the heliocentric velocity vector variable

name of the heliocentric velocity vector variable

ID for the ring particle relative velocity per bin variable already defined in netcdf_io_module

name of the ring particle relative velocity per bin variable

Finalizer will close the NetCDF file

Adds a new variable to an existing open dataset by combining inq_varid, redef, def_var, and def_var_fill commands in one

Closes an open NetCDF file

Finds the id dimension index for a given value of id

Finds the time dimension index for a given value of t

Flushes a NetCDF file by closing it then opening it again

Gets the valid id numbers currently stored in this dataset

Open a Ringmoons NetCDF file

Syncrhonize the disk and memory buffer of the NetCDF file (e.g. commit the frame files stored in memory to disk)

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

Bond albedo for radiation acceleration calculations

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

Emissivity for Yarkovsky acceleration calculations

Thermal inertia for Yarkovsky calculations

Identifier

Inclination

Particle metadata information

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

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

level at which this body should be moved

deepest encounter level achieved 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])

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

Hill’s radius (units DU)

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

Constant based on rotation rate for yarkovsky calculations

An integrator-specific status indicator

Tidal phase lag

Barycentric velocity

Velocity at beginning of step

Heliocentric velocity

Compute heliocentric accelerations of massive bodies

Acceleration term arising from the post-Newtonian correction

Compute direct cross (third) term heliocentric accelerations of massive bodiess, with no mutual interactions between bodies below GMTINY

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

Add user-supplied heliocentric accelerations to planets

Compute the heliocentric accelerations of bodies due to the Yarkovsky effect

Appends elements from one structure to another

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

Deallocates all allocatable arrays

Process massive body discards

Method for Danby drift in Democratic Heliocentric coordinates. Sets the mask to the current recursion level

Convert orbital elements to position and velocity vectors

Checks if massive bodies are going through close encounters with each other

“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)

Kicks the barycentric velocities

Method for linear drift of massive bodies due to barycentric momentum of Sun

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 SyMBA massive 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 the inverse heliocentric radius term (1/rh**3)

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

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

Sets the critical radius for encounter given an input recursion depth

Calculates the Hill’s radii for each body

Constructor method - Allocates space for the input number of bodies

Sorts body arrays by a sortable componen

“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)

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

Rigid and fluid Roche limits

G*surface mass density of ring bin

polar moment of inertia of ring bin

Toomre parameter of the ring bin

Rigid and fluid Roche limits

total satellite torque density acting on the ring bin

distance variable X bin center used for viscosity calculations

distance variable X**2 bin center used for viscosity calculations

inside radius of ring in X units (see Bath & Pringle 1981)

outside radius of ring in X units (see Bath & Pringle 1981)

2nd row-1st column term of the Yarkovsky directional matrix (Ferich, et al, 2022; Veras, et al, 2015)

semi-major axis of the planet from the Sun

Bond albedo of ring particles for Yarkovsky acceleration calculations

planetary shadow width

differential surface area of ring

variable changed bin width used for viscosity calculations in X units

Emissivity for Yarkovsky acceleration calculations

Thermal inertia for Yarkovsky-Schach calculations

Indexes of Roche limit bins

Indexes of Roche limit bins

bin id of innermost ring bin (can increase if primary accretes a lot mass through updates)

ring particle mass per bin

mass of ring particles in bin

number of bins in ring

NetCDF file object associated with this ring stucture

Keplerian angular velocity of ring bin

viscocity of the ring bin

obliquity of the planet from the Sun

radial distance of center of bin in simulation length units

normalized ring Hill’s radius in simulation length units

inside radius of ring in simulation length units

outside radius of ring in simulation length units

ring particle radius per bin

ring particle mass density per bin

Constant based on rotation rate for Yarkovsky calculations

surface mass density of ring bin

Integration current time (set internally from the nbody_system)

ring optical depth

ring particle relative velocity per bin

Finalizes the ringmoons ring object - deallocates all allocatables

Deallocates allocatable arrays

Returns the bin containing radius r from the input ring.

Calculates the maximum stable timestep for the surface mass density evolution that is not larger than dtin.

Calculates the lindblad torques between each ring element and an input body.

Read in ring data from file

Resets ring torques and recomputes all dimensional quantities, such as ring extent and limits based on the current surface mass density and central body properties.

Calculates the velocity

Sets up a new ring system from an input file

Adnances the evolution of the ring by one time step.

Updates the ring velocity dispersion, Toomre parameter, and viscosity values

Writes ring data to file

Calculates the torque from the Yarkovsky-Schach effect on the ring

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

Total torque acting on the seed

Tidal torque acting on the seed

Semimajor axis

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

Width of feeding zone for seed mergers in units of mutual Hill’s sphere

Identifier

Particle metadata information

Body mass (units MU)

initial mass of seeds

Current maximum id of the system, set automatically from the nbody_system object

Gravitational cononstant

Number of seed bodies

Body radius (units DU)

Hill’s radius (units DU)

Ring bin location of seed

Error tolerance for Runge-Kutta-Fehlberg integrator for seed evolution

Active or inactive status indicator

Deallocates all allocatable arrays

Calculates the tidal torque on the seed from the central body

Read seed data from file

Restructures the seed system by merging seeds that are within each other’s feeding zones and reassigning ring bins based on current semimajor axes

Sets up a new seed system from an input file

Spawn new seeds from the ring at the FRL

Advances the evolution of the seeds by one time step, including accretion and spawning events

Writes seed data to file

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

level at which this particle should be moved

deepest encounter level achieved 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])