search

UtkrishtDhankar / brayton-cycle

Software to simulate the brayton cycle. Made for IC-142 Engineering Thermodynamics in IIT Mandi.
MIT License
2 stars 3 forks source link

Fix boiler.h/boiler.c documentation #20

Open UtkrishtDhankar opened 8 years ago

UtkrishtDhankar commented 8 years ago

boiler.h and boiler.c's documentation of function arguments is weird and contradictory. e.g, 

double calc_fuel_flow_rate(
    double t_in,        // desired outlet temperature of the gas in K
    double t_out,       // inlet temperature of the gas in K
    double gas_flow_rate    // flow rate of the gas in kg/s
);

What is t_in here? What is t_out? There's similar examples throughout.

We need to look at the code and fix the documentation.