InputParameters.py File Reference

Provides the function for reading inputs and the function for checking the physical constraints and software constraints on the input. More...

Functions
	python.InputParameters.get_input (filename)
	Reads input from a file with the given file name.
	python.InputParameters.input_constraints (m_1, m_2, x_1_0, y_1_0, x_2_0, y_2_0, v_x1_0, v_y1_0, v_x2_0, v_y2_0, t_final)
	Verifies that input values satisfy the physical constraints and software constraints.

Detailed Description

Provides the function for reading inputs and the function for checking the physical constraints and software constraints on the input.

Author

Xinlu Yan

Note

Generated by Drasil v0.1-alpha

Function Documentation

get_input()

python.InputParameters.get_input

(

filename

)

Reads input from a file with the given file name.

Parameters

filename

name of the input file

Returns

mass of the first star (kg)

mass of the second star (kg)

initial x-position of the first star (m)

initial y-position of the first star (m)

initial x-position of the second star (m)

initial y-position of the second star (m)

initial x-velocity of the first star (m/s)

initial y-velocity of the first star (m/s)

initial x-velocity of the second star (m/s)

initial y-velocity of the second star (m/s)

final time (s)

input_constraints()

python.InputParameters.input_constraints	(		m_1,
			m_2,
			x_1_0,
			y_1_0,
			x_2_0,
			y_2_0,
			v_x1_0,
			v_y1_0,
			v_x2_0,
			v_y2_0,
			t_final )

Verifies that input values satisfy the physical constraints and software constraints.

Parameters

m_1	mass of the first star (kg)
m_2	mass of the second star (kg)
x_1_0	initial x-position of the first star (m)
y_1_0	initial y-position of the first star (m)
x_2_0	initial x-position of the second star (m)
y_2_0	initial y-position of the second star (m)
v_x1_0	initial x-velocity of the first star (m/s)
v_y1_0	initial y-velocity of the first star (m/s)
v_x2_0	initial x-velocity of the second star (m/s)
v_y2_0	initial y-velocity of the second star (m/s)
t_final	final time (s)