model.model_parker Namespace Reference

Classes
class	ModelParkerError
	Error returned by model_parker. More...

Functions
def	compute_footprint
	Use Parker spiral to compute SC/planet footpoint on source surface and delay between SC/planet and source surface. More...
def	draw_parker_spiral_magnetic_field
	Compute at some point Parker spiral magnetic vector Bspiral in IAU_SUN coordinates and the oriented angle (-e_phi,Bspiral). More...
def	draw_parker_spiral_point
	Draw Parker spiral points from a given start down to solar source surface. More...
def	suntime_backward
	For a given time, compute the corresponding time for the scraft such that its Parker spiral's time arrival on source surface is (more or less) this input time. More...

Variables
int	vhelio_min = 300
int	vhelio_max = 800
float	rmid = 21.5

Function Documentation

def model.model_parker.compute_footprint	(		positions,
			vhelio = None,
			rss = 2.5
	)

Use Parker spiral to compute SC/planet footpoint on source surface and delay between SC/planet and source surface.

Achtung! Before using this function, must give a value to some module_heliosphere variables:

• vhelio
• rss

Parameters

[in]	positions	List of module_timespace.Coordinate() objects in the heliosphere where Parker spiral starts.
[out]	positions_ss	List of module_timespace.Coordinate() objects. Footpoint of Parker spiral on source surface.
[out]	delays_ss	List of datetime.timedelta() objects. Propagation delay between positions and positions_ss.

Check:

• Check module_heliosphere.vhelio is a float between 100 and 1000.
• Check module_heliosphere.rss is in [2.,3.]
• Check if SC/Planet radius is strictly above rss

If a test fails, returns a ModelParkerError.

Here is the call graph for this function:

Here is the caller graph for this function:

def model.model_parker.draw_parker_spiral_magnetic_field	(		r,
			lon,
			v
	)

Compute at some point Parker spiral magnetic vector Bspiral in IAU_SUN coordinates and the oriented angle (-e_phi,Bspiral).

Parameters

[in]	r	radius in kilometers of the point
[in]	lon	longitude in degree of the point
[in]	v	plasma velocity in km/s

Parameters

[out]	bx,by	2 composantes of magnetic vector in IAU_SUN
[out]	angle_spiral	angle in degree between -{e_{}} and {B_{spiral}}

def model.model_parker.draw_parker_spiral_point	(		rstart,
			lon,
			lat,
			v,
			npoint = 10
	)

Draw Parker spiral points from a given start down to solar source surface.

Point's abscissae and ordinates are given in IAU_SUN coordinates.

Parameters

[in]	rstart	radius in kilometers of the starting point
[in]	lon	longitude in degree of the starting point
[in]	lat	latitude in degree of the starting point
[in]	v	plasma velocity in km/s
[in]	npoint	number of spiral points to be displayed. Default 10.
[out]	x_list	list of abscissae
[out]	y_list	list of ordinates

def model.model_parker.suntime_backward	(		scraft,
			date_surf,
			rss = 2.5,
			verbose = False
	)

For a given time, compute the corresponding time for the scraft such that its Parker spiral's time arrival on source surface is (more or less) this input time.

Parameters

[in]	scraft
[in]	date_surf	Datetime.datetime() object. Time arrival of scraft's Parker spiral on source surface.
[in]	rss	Height of source surface in solar radii
[out]	date_sc	Datetime.datetime() object. At this time, the Parker spiral starting at the corresponding scraft position reach the source surface at the input date_surf time.
[out]	error	Number of hour between the arrival time of Parker spiral and the input date_surf.

Here is the call graph for this function:

Variable Documentation

float model.model_parker.rmid = 21.5

int model.model_parker.vhelio_max = 800

int model.model_parker.vhelio_min = 300