orbital_evolution.planet_interface module

Class Inheritance Diagram

An interface to the POET planet library.

class orbital_evolution.planet_interface.LockedPlanet(mass, radius)

Bases: orbital_evolution.dissipating_body.DissipatingBody

A class for tidally locked and thus non-dissipative planets.

__init__(mass, radius)

Create a planet with the given mass and radius.

Parameters:

• mass (-) – The mass of the planet in solar masses.
• radius (-) – The radius of the planet in solar radii.

Returns: None

delete()

Destroy the library planet created at construction.

lib_configure_body = <_FuncPtr object>

set_dissipation(*, tidal_frequency_breaks, spin_frequency_breaks, tidal_frequency_powers, spin_frequency_powers, reference_phase_lag, inertial_mode_enhancement=1.0, inertial_mode_sharpness=10.0)

Set the dissipaation of the only zone of the planet.

See EvolvingStar.set_dissipation() for description of the arguments.

Returns:None

orbital_evolution.planet_interface.initialize_library(library_fname=None)

Prepare the planet library for use and return it.