InputParameters.hpp File Reference

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

#include <string>
#include "Constants.hpp"

Go to the source code of this file.

Functions
void	get_input (string filename, double &m_1, double &m_2, double &x_1_0, double &y_1_0, double &x_2_0, double &y_2_0, double &v_x1_0, double &v_y1_0, double &v_x2_0, double &v_y2_0, double &t_final)
	Reads input from a file with the given file name.
void	input_constraints (double m_1, double m_2, double x_1_0, double y_1_0, double x_2_0, double y_2_0, double v_x1_0, double v_y1_0, double v_x2_0, double v_y2_0, double 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()

void get_input	(	string	filename,
		double &	m_1,
		double &	m_2,
		double &	x_1_0,
		double &	y_1_0,
		double &	x_2_0,
		double &	y_2_0,
		double &	v_x1_0,
		double &	v_y1_0,
		double &	v_x2_0,
		double &	v_y2_0,
		double &	t_final )

Reads input from a file with the given file name.

Parameters

filename	name of the input file
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)

input_constraints()

void input_constraints	(	double	m_1,
		double	m_2,
		double	x_1_0,
		double	y_1_0,
		double	x_2_0,
		double	y_2_0,
		double	v_x1_0,
		double	v_y1_0,
		double	v_x2_0,
		double	v_y2_0,
		double	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)