InputParameters.py File Reference

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

Functions
def	python.InputParameters.get_input (filename)
	Reads input from a file with the given file name. More...
def	python.InputParameters.input_constraints (r_t, K_d, K_p, t_step, t_sim)
	Verifies that input values satisfy the physical constraints. More...

Detailed Description

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

Author

Naveen Ganesh Muralidharan

Note

Generated by Drasil v0.1-alpha

Function Documentation

get_input()

def python.InputParameters.get_input

(

filename

)

Reads input from a file with the given file name.

Parameters

filename

name of the input file

Returns

Set-Point: The desired value that the control system must reach. This also knows as the reference variable

Derivative Gain: Gain constant of the derivative controller

Proportional Gain: Gain constant of the proportional controller

Step Time: Simulation step time (s)

Simulation Time: Total execution time of the PD simulation (s)

input_constraints()

def python.InputParameters.input_constraints	(		r_t,
			K_d,
			K_p,
			t_step,
			t_sim
	)

Verifies that input values satisfy the physical constraints.

Parameters

r_t	Set-Point: The desired value that the control system must reach. This also knows as the reference variable
K_d	Derivative Gain: Gain constant of the derivative controller
K_p	Proportional Gain: Gain constant of the proportional controller
t_step	Step Time: Simulation step time (s)
t_sim	Simulation Time: Total execution time of the PD simulation (s)