SWHSNoPCM
All Classes Files Functions
Functions
InputParameters.py File Reference

Provides the function for reading inputs, the function for calculating derived values, and the function for checking the physical constraints and software 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.derived_values (D, L)
 Calculates values that can be immediately derived from the inputs. More...
 
def python.InputParameters.input_constraints (A_C, C_W, h_C, T_init, t_final, L, T_C, t_step, rho_W, D, E_W)
 Verifies that input values satisfy the physical constraints and software constraints. More...
 

Detailed Description

Provides the function for reading inputs, the function for calculating derived values, and the function for checking the physical constraints and software constraints on the input.

Author
Thulasi Jegatheesan
Note
Generated by Drasil v0.1-alpha

Function Documentation

◆ derived_values()

def python.InputParameters.derived_values (   D,
  L 
)

Calculates values that can be immediately derived from the inputs.

Parameters
Ddiameter of tank: the diameter of the tank (m)
Llength of tank: the length of the tank (m)
Returns
volume of the cylindrical tank: the amount of space encompassed by a tank (m^3)

◆ get_input()

def python.InputParameters.get_input (   filename)

Reads input from a file with the given file name.

Parameters
filenamename of the input file
Returns
heating coil surface area: area covered by the outermost layer of the coil (m^2)
specific heat capacity of water: the amount of energy required to raise the temperature of a given unit mass of water by a given amount (J/(kg degreeC))
convective heat transfer coefficient between coil and water: the convective heat transfer coefficient that models the thermal flux from the coil to the surrounding water (W/(m^2 degreeC))
initial temperature: the temperature at the beginning of the simulation (degreeC)
final time: the amount of time elapsed from the beginning of the simulation to its conclusion (s)
length of tank: the length of the tank (m)
temperature of the heating coil: the average kinetic energy of the particles within the coil (degreeC)
time step for simulation: the finite discretization of time used in the numerical method for solving the computational model (s)
density of water: mass per unit volume of water (kg/m^3)
diameter of tank: the diameter of the tank (m)
absolute tolerance
relative tolerance
change in heat energy in the water: change in thermal energy within the water (J)

◆ input_constraints()

def python.InputParameters.input_constraints (   A_C,
  C_W,
  h_C,
  T_init,
  t_final,
  L,
  T_C,
  t_step,
  rho_W,
  D,
  E_W 
)

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

Parameters
A_Cheating coil surface area: area covered by the outermost layer of the coil (m^2)
C_Wspecific heat capacity of water: the amount of energy required to raise the temperature of a given unit mass of water by a given amount (J/(kg degreeC))
h_Cconvective heat transfer coefficient between coil and water: the convective heat transfer coefficient that models the thermal flux from the coil to the surrounding water (W/(m^2 degreeC))
T_initinitial temperature: the temperature at the beginning of the simulation (degreeC)
t_finalfinal time: the amount of time elapsed from the beginning of the simulation to its conclusion (s)
Llength of tank: the length of the tank (m)
T_Ctemperature of the heating coil: the average kinetic energy of the particles within the coil (degreeC)
t_steptime step for simulation: the finite discretization of time used in the numerical method for solving the computational model (s)
rho_Wdensity of water: mass per unit volume of water (kg/m^3)
Ddiameter of tank: the diameter of the tank (m)
E_Wchange in heat energy in the water: change in thermal energy within the water (J)