Data access methods and properties ================================== By default, run variables have the format :code:`[object, time, dimension(s)]`. * For scalar quantities, such as distance magnitude, there is no :code:`dimension` coordinate(s). * For general quantities, such as `time`, or for select quantities returned by some methods, there is no :code:`object` coordinate. * Some quantities, such as quadrupole tensor, may have two dimensions. Often, these quantities will be named with a double letter. * Some quantities, such as :code:`names`, may have only an :code:`object` coordinate. Some quantities that require no options and that are fast to compute are returned as attributes. Some attributes are also cached, so access is fast. .. module:: multistar.base General ------- Attributes ^^^^^^^^^^ t time (s) y solution vector(s) nstar number of stars norb number of orbits ``nstar``-1 Properties ^^^^^^^^^^ .. autoproperty:: OrbitBase.dt .. autoproperty:: OrbitBase.norbit .. autoproperty:: OrbitBase.orbit_names .. autoproperty:: OrbitBase.orbit_masses .. autoproperty:: OrbitBase.mo .. autoproperty:: OrbitBase.orbits .. autoproperty:: OrbitBase.names .. autoproperty:: OrbitBase.star_names Objects ------- Properties ^^^^^^^^^^ .. autoproperty:: OrbitBase.m .. autoproperty:: OrbitBase.R .. autoproperty:: OrbitBase.s .. autoproperty:: OrbitBase.k .. autoproperty:: OrbitBase.tau .. autoproperty:: OrbitBase.Q .. autoproperty:: OrbitBase.kt .. autoproperty:: OrbitBase.s5k .. autoproperty:: OrbitBase.i .. note:: Raw format of moment of inertial is to only set the z component to non-zero value for scalar moment of inertia (spherically symmetric body). TODO Equally possible would be to set the z component to a negative value, saves on tests (only test one quantity for being negative), but adds a floating point operation (invert sign). Maybe it would be easier to just set all components to equal values, should be save enough and also requires only two tests. .. autoproperty:: OrbitBase.ix .. autoproperty:: OrbitBase.iy .. autoproperty:: OrbitBase.iz .. autoproperty:: OrbitBase.i_ .. autoproperty:: OrbitBase.ix_ .. autoproperty:: OrbitBase.iy_ .. autoproperty:: OrbitBase.iz_ .. autoproperty:: OrbitBase.ii_ .. autoproperty:: OrbitBase.ii .. autoproperty:: OrbitBase.iii .. autoproperty:: OrbitBase.q .. autoproperty:: OrbitBase.qq .. autoproperty:: OrbitBase.qq_ .. autoproperty:: OrbitBase.axes .. autoproperty:: OrbitBase.dims .. autoproperty:: OrbitBase.j .. autoproperty:: OrbitBase.jn .. autoproperty:: OrbitBase.w .. autoproperty:: OrbitBase.wn .. autoproperty:: OrbitBase.wabc .. autoproperty:: OrbitBase.P .. autoproperty:: OrbitBase.erot .. autoproperty:: OrbitBase.f .. autoproperty:: OrbitBase.fdot .. autoproperty:: OrbitBase.fdotabc .. autoproperty:: OrbitBase.o .. autoproperty:: OrbitBase.on .. autoproperty:: OrbitBase.odot .. autoproperty:: OrbitBase.A .. autoproperty:: OrbitBase.e .. autoproperty:: OrbitBase.edot Generic methods --------------- .. automethod:: OrbitBase.Qo .. automethod:: OrbitBase.phase_lag General dynamic (direct) driver ------------------------------- Properties ^^^^^^^^^^ .. autoproperty:: DirectBase.r .. autoproperty:: DirectBase.rn .. autoproperty:: DirectBase.v .. autoproperty:: DirectBase.vn .. autoproperty:: DirectBase.ro .. autoproperty:: DirectBase.ron .. autoproperty:: DirectBase.vo .. autoproperty:: DirectBase.von .. autoproperty:: DirectBase.vro .. autoproperty:: DirectBase.jo .. autoproperty:: DirectBase.jon .. autoproperty:: DirectBase.h .. autoproperty:: DirectBase.hn .. autoproperty:: DirectBase.jt .. autoproperty:: DirectBase.inc .. autoproperty:: DirectBase.obliquity .. autoproperty:: DirectBase.oblt .. autoproperty:: DirectBase.oblo .. autoproperty:: DirectBase.inco .. autoproperty:: DirectBase.wo .. autoproperty:: DirectBase.won .. autoproperty:: DirectBase.Po .. autoproperty:: DirectBase.woi .. autoproperty:: DirectBase.woin .. autoproperty:: DirectBase.Poi .. autoproperty:: DirectBase.jc .. autoproperty:: DirectBase.p .. autoproperty:: DirectBase.ekin .. autoproperty:: DirectBase.mu .. autoproperty:: DirectBase.n Methods ^^^^^^^ Parameter types for data methods """""""""""""""""""""""""""""""" stars star name, index, or tuple thereof. i time slice index t time for time slice (s) elim limit for when :code:`1 - eccentricity` is considered a parabolic orbit Data methods """""""""""" .. automethod:: DirectBase.dr .. automethod:: DirectBase.drn .. automethod:: DirectBase.dv .. automethod:: DirectBase.dvn .. automethod:: DirectBase.r_cms .. automethod:: DirectBase.rn_cms .. automethod:: DirectBase.v_cms .. automethod:: DirectBase.vn_cms .. automethod:: DirectBase.rvm .. automethod:: DirectBase.aben .. automethod:: DirectBase.anen .. automethod:: DirectBase.rp .. automethod:: DirectBase.ra .. automethod:: DirectBase.a .. automethod:: DirectBase.an .. automethod:: DirectBase.b .. automethod:: DirectBase.bn .. automethod:: DirectBase.en .. automethod:: DirectBase.Pg .. automethod:: DirectBase.anomaly .. automethod:: DirectBase.mean .. automethod:: DirectBase.eccentric .. automethod:: DirectBase.vperi .. automethod:: DirectBase.vapo .. automethod:: DirectBase.abeno .. automethod:: DirectBase.ao .. automethod:: DirectBase.bo .. automethod:: DirectBase.eo .. automethod:: DirectBase.aneno .. automethod:: DirectBase.ano .. automethod:: DirectBase.bno .. automethod:: DirectBase.eno .. automethod:: DirectBase.Ao .. automethod:: DirectBase.rpo .. automethod:: DirectBase.rao .. automethod:: DirectBase.anrpo Operational effective values for non-keplerian orbits """"""""""""""""""""""""""""""""""""""""""""""""""""" .. automethod:: DirectBase.effenwn .. automethod:: DirectBase.effwn .. automethod:: DirectBase.effen .. automethod:: DirectBase.effP .. automethod:: DirectBase.effenwno .. automethod:: DirectBase.effwno .. automethod:: DirectBase.effeno .. automethod:: DirectBase.effPo Sidereal and synodic values """"""""""""""""""""""""""" .. automethod:: DirectBase.Psyn .. automethod:: DirectBase.wsyn .. automethod:: DirectBase.Psid .. automethod:: DirectBase.wsid Orbital elements """""""""""""""" .. automethod:: DirectBase.aeiwWfo GW signal ^^^^^^^^^ .. autoproperty:: DirectBase.gw .. autoproperty:: DirectBase.gww .. autoproperty:: DirectBase.gwp .. autoproperty:: DirectBase.gwhh .. autoproperty:: DirectBase.gwhh1 .. autoproperty:: DirectBase.gwhh2 .. autoproperty:: DirectBase.gwhhap .. autoproperty:: DirectBase.gwhha .. autoproperty:: DirectBase.gwha .. autoproperty:: DirectBase.gwtheta .. autoproperty:: DirectBase.ngw .. autoproperty:: DirectBase.gwname .. autoproperty:: DirectBase.gwacc .. autoproperty:: DirectBase.gwnear .. autoproperty:: DirectBase.gwnearhh2 .. autoproperty:: DirectBase.gwnearw .. autoproperty:: DirectBase.gwnearp .. autoproperty:: DirectBase.gwqq .. autoproperty:: DirectBase.gwqq0 .. autoproperty:: DirectBase.gwqq1 .. autoproperty:: DirectBase.gwqq2 .. autoproperty:: DirectBase.gwqq3 .. autoproperty:: DirectBase.gwqq4 .. autoproperty:: DirectBase.gwqqw Collision data ^^^^^^^^^^^^^^ .. autoproperty:: DirectBase.collision Binary direct driver (Direct2) ------------------------------ .. module:: multistar.direct Methods ^^^^^^^ .. automethod:: Direct2.jGR Secular driver (Secular2) ------------------------- .. module:: multistar.secular Properties ^^^^^^^^^^ .. autoproperty:: Secular2.h .. autoproperty:: Secular2.hn .. autoproperty:: Secular2.h1 .. autoproperty:: Secular2.e .. autoproperty:: Secular2.en .. autoproperty:: Secular2.e1 .. autoproperty:: Secular2.j1 .. autoproperty:: Secular2.j2 .. autoproperty:: Secular2.n .. autoproperty:: Secular2.wo .. autoproperty:: Secular2.won .. autoproperty:: Secular2.Po .. autoproperty:: Secular2.M .. autoproperty:: Secular2.an