CInterface.h File Reference

Declare C-style functions for working with LockedPlanet instances. More...

#include "../Core/SharedLibraryExportMacros.h"
#include "Planet.h"

Include dependency graph for CInterface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
LIB_PUBLIC CPlanet *	create_planet (double mass, double radius)
	Create a planet to use in a evolution calculation. More...
LIB_PUBLIC void	destroy_planet (CPlanet *planet)
	Destroy a planet previously allocated using create_planet. More...
LIB_PUBLIC void	set_planet_dissipation (CPlanet *planet, unsigned num_tidal_frequency_breaks, unsigned num_spin_frequency_breaks, double *tidal_frequency_breaks, double *spin_frequency_breaks, double *tidal_frequency_powers, double *spin_frequency_powers, double reference_phase_lag, double inertial_mode_enhancement, double inertial_mode_sharpness)
	Set the dissipative properties of the planet. More...

Detailed Description

Declare C-style functions for working with LockedPlanet instances.

Definition in file CInterface.h.

Function Documentation

create_planet()

LIB_PUBLIC CPlanet* create_planet	(	double	mass,
		double	radius
	)

Create a planet to use in a evolution calculation.

The result must be de-allocated by the caller.

Parameters

mass	The mass of the planet to create.
radius	The radius of the planet to create.

Definition at line 12 of file CInterface.cpp.

destroy_planet()

LIB_PUBLIC void destroy_planet

(

CPlanet *

planet

)

Destroy a planet previously allocated using create_planet.

Definition at line 19 of file CInterface.cpp.

set_planet_dissipation()

LIB_PUBLIC void set_planet_dissipation	(	CPlanet *	planet,
		unsigned	num_tidal_frequency_breaks,
		unsigned	num_spin_frequency_breaks,
		double *	tidal_frequency_breaks,
		double *	spin_frequency_breaks,
		double *	tidal_frequency_powers,
		double *	spin_frequency_powers,
		double	reference_phase_lag,
		double	inertial_mode_enhancement,
		double	inertial_mode_sharpness
	)

Set the dissipative properties of the planet.

Parameters

planet	The star to set the dissipation for.
num_tidal_frequency_breaks	See same name argument to set_zone_dissipation()
num_spin_frequency_breaks	See same name argument to set_zone_dissipation()
tidal_frequency_breaks	See same name argument to set_zone_dissipation()
spin_frequency_breaks	See same name argument to set_zone_dissipation()
tidal_frequency_powers	See same name argument to set_zone_dissipation()
spin_frequency_powers	See same name argument to set_zone_dissipation()
reference_phase_lag	See same name argument to set_zone_dissipation()
inertial_mode_enhancement	See same name argument to set_zone_dissipation()
inertial_mode_sharpness	See same name argument to set_zone_dissipation()

Definition at line 24 of file CInterface.cpp.