AguaClara
EXPERIMENTAL
API Reference
Developer Guide
AguaClara
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
V
|
W
_
__init__() (aguaclara.research.floc_model.Chemical method)
(aguaclara.research.floc_model.Material method)
(aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
A
ACRYLIC_T (in module aguaclara.core.materials)
aeration_data() (in module aguaclara.research.environmental_processes_analysis)
aguaclara.core.constants
module
aguaclara.core.drills
module
aguaclara.core.materials
module
aguaclara.core.physchem
module
aguaclara.core.pipes
module
aguaclara.core.units
module
aguaclara.core.utility
module
aguaclara.design.cdc
module
aguaclara.design.component
module
aguaclara.design.ent
module
aguaclara.design.ent_floc
module
aguaclara.design.floc
module
aguaclara.design.lfom
module
aguaclara.design.pipeline
module
aguaclara.design.sed
module
aguaclara.design.sed_chan
module
aguaclara.design.sed_tank
module
aguaclara.research.environmental_processes_analysis
module
aguaclara.research.floc_model
module
aguaclara.research.peristaltic_pump
module
aguaclara.research.procoda_parser
module
AIR_NU (in module aguaclara.core.constants)
alpha0_carbonate() (in module aguaclara.research.environmental_processes_analysis)
alpha1_carbonate() (in module aguaclara.research.environmental_processes_analysis)
alpha2_carbonate() (in module aguaclara.research.environmental_processes_analysis)
Alum (in module aguaclara.research.floc_model)
alum_nu() (aguaclara.design.cdc.CDC method)
ANC_closed() (in module aguaclara.research.environmental_processes_analysis)
ANC_open() (in module aguaclara.research.environmental_processes_analysis)
area_circle() (in module aguaclara.core.physchem)
area_orifice() (in module aguaclara.core.physchem)
array_qtys_to_strs() (in module aguaclara.core.utility)
ATM_P (in module aguaclara.core.constants)
average_state() (in module aguaclara.research.procoda_parser)
B
baffle_s (aguaclara.design.floc.Flocculator property)
C
C_stock() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
C_sys() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
cap_thickness() (in module aguaclara.core.pipes)
CDC (class in aguaclara.design.cdc)
ceil_nearest() (in module aguaclara.core.utility)
ceil_step() (in module aguaclara.core.utility)
chan_l (aguaclara.design.floc.Flocculator property)
chan_n (aguaclara.design.floc.Flocculator property)
chan_w (aguaclara.design.floc.Flocculator property)
chan_w_min (aguaclara.design.floc.Flocculator property)
chan_w_min_gt (aguaclara.design.floc.Flocculator property)
chan_w_min_hs_ratio (aguaclara.design.floc.Flocculator property)
check_range() (in module aguaclara.core.utility)
Chemical (class in aguaclara.research.floc_model)
Clay (in module aguaclara.research.floc_model)
CMFR() (in module aguaclara.research.environmental_processes_analysis)
coag_nu() (aguaclara.design.cdc.CDC method)
coag_q_max (aguaclara.design.cdc.CDC property)
coag_q_max_est (aguaclara.design.cdc.CDC property)
coag_sack_n (aguaclara.design.cdc.CDC property)
coag_stock_nu (aguaclara.design.cdc.CDC property)
coag_stock_time_min (aguaclara.design.cdc.CDC property)
coag_stock_vol (aguaclara.design.cdc.CDC property)
coag_tank_h (aguaclara.design.cdc.CDC property)
coag_tank_r (aguaclara.design.cdc.CDC property)
coag_tube_l (aguaclara.design.cdc.CDC property)
coag_tube_operating_q_max (aguaclara.design.cdc.CDC property)
coag_tubes_active_n (aguaclara.design.cdc.CDC property)
coag_tubes_n (aguaclara.design.cdc.CDC property)
column_of_data() (in module aguaclara.research.procoda_parser)
column_of_time() (in module aguaclara.research.procoda_parser)
Component (class in aguaclara.design.component)
conc_floc() (in module aguaclara.research.floc_model)
conc_precipitate() (in module aguaclara.research.floc_model)
CONCRETE_DENSITY (in module aguaclara.core.materials)
CONCRETE_PIPE_ROUGH (in module aguaclara.core.materials)
CONCRETE_THICKNESS_MIN (in module aguaclara.core.materials)
contraction_s (aguaclara.design.floc.Flocculator property)
D
dean_number() (in module aguaclara.research.floc_model)
define_Precip() (aguaclara.research.floc_model.Chemical method)
dens_alum_nanocluster() (in module aguaclara.research.floc_model)
dens_floc() (in module aguaclara.research.floc_model)
dens_floc_init() (in module aguaclara.research.floc_model)
dens_pacl_solution() (in module aguaclara.research.floc_model)
density_air() (in module aguaclara.core.physchem)
density_gas() (in module aguaclara.core.physchem)
density_water() (in module aguaclara.core.physchem)
DeprecatedFunctionError
diam_circle() (in module aguaclara.core.physchem)
diam_floc_max() (in module aguaclara.research.floc_model)
diam_floc_vel_term() (in module aguaclara.research.floc_model)
diam_fractal() (in module aguaclara.research.floc_model)
diam_hagen() (in module aguaclara.core.physchem)
diam_kolmogorov() (in module aguaclara.research.floc_model)
diam_major_pipe() (in module aguaclara.core.physchem)
diam_minor_pipe() (in module aguaclara.core.physchem)
diam_pipe() (in module aguaclara.core.physchem)
diam_pipemajor() (in module aguaclara.core.physchem)
diam_pipeminor() (in module aguaclara.core.physchem)
diam_swamee() (in module aguaclara.core.physchem)
diffuser_a (aguaclara.design.sed_tank.SedimentationTank property)
diffuser_hl (aguaclara.design.sed_tank.SedimentationTank property)
diffuser_vel (aguaclara.design.sed_tank.SedimentationTank property)
diffuser_w_inner (aguaclara.design.sed_tank.SedimentationTank property)
dilution_factor() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
DIM_FRACTAL (in module aguaclara.research.floc_model)
drill_bit_a (aguaclara.design.lfom.LFOM property)
E
E_Advective_Dispersion() (in module aguaclara.research.environmental_processes_analysis)
E_CMFR_N() (in module aguaclara.research.environmental_processes_analysis)
Elbow (class in aguaclara.design.pipeline)
elbow_minor_loss() (in module aguaclara.core.physchem)
ener_dis_diam_floc() (in module aguaclara.research.floc_model)
EntranceTank (class in aguaclara.design.ent)
EntTankFloc (class in aguaclara.design.ent_floc)
error_per_row (aguaclara.design.lfom.LFOM property)
expansion_h (aguaclara.design.floc.Flocculator property)
expansion_h_max (aguaclara.design.floc.Flocculator property)
expansion_n (aguaclara.design.floc.Flocculator property)
F
fitting_od() (in module aguaclara.core.pipes)
floc_weir_h (aguaclara.design.sed_tank.SedimentationTank property)
Flocculator (class in aguaclara.design.floc)
floor_nearest() (in module aguaclara.core.utility)
floor_step() (in module aguaclara.core.utility)
flow_hagen() (in module aguaclara.core.physchem)
flow_major_pipe() (in module aguaclara.core.physchem)
flow_minor_pipe() (in module aguaclara.core.physchem)
flow_orifice() (in module aguaclara.core.physchem)
flow_orifice_vert() (in module aguaclara.core.physchem)
flow_pipe() (in module aguaclara.core.physchem)
flow_pipeline() (aguaclara.design.pipeline.PipelineComponent method)
flow_pipemajor() (in module aguaclara.core.physchem)
flow_pipeminor() (in module aguaclara.core.physchem)
flow_rate() (in module aguaclara.research.peristaltic_pump)
flow_rect_weir() (in module aguaclara.core.physchem)
flow_swamee() (in module aguaclara.core.physchem)
flow_transition() (in module aguaclara.core.physchem)
flow_weir_rect() (in module aguaclara.core.physchem)
format_print() (aguaclara.design.pipeline.Elbow method)
(aguaclara.design.pipeline.Pipe method)
(aguaclara.design.pipeline.PipelineComponent method)
(aguaclara.design.pipeline.Tee method)
frac_vol_floc() (in module aguaclara.research.floc_model)
frac_vol_floc_initial() (in module aguaclara.research.floc_model)
fric() (in module aguaclara.core.physchem)
fric_channel() (in module aguaclara.core.physchem)
fric_ergun() (in module aguaclara.core.physchem)
fric_general() (in module aguaclara.core.physchem)
fric_pipe() (in module aguaclara.core.physchem)
fric_rect() (in module aguaclara.core.physchem)
G
g_coil() (in module aguaclara.research.floc_model)
g_cs_ergun() (in module aguaclara.core.physchem)
g_time_res() (in module aguaclara.research.floc_model)
gamma_coag() (in module aguaclara.research.floc_model)
gamma_humic_acid_to_coag() (in module aguaclara.research.floc_model)
get_data_by_state() (in module aguaclara.research.procoda_parser)
get_data_by_time() (in module aguaclara.research.procoda_parser)
get_drill_bits_d_imperial() (in module aguaclara.core.drills)
get_drill_bits_d_metric() (in module aguaclara.core.drills)
get_sdr() (in module aguaclara.core.utility)
Gran() (in module aguaclara.research.environmental_processes_analysis)
GRAVITY (in module aguaclara.core.constants)
H
head_orifice() (in module aguaclara.core.physchem)
headloss (aguaclara.design.pipeline.Elbow property)
(aguaclara.design.pipeline.Pipe property)
(aguaclara.design.pipeline.Tee property)
headloss() (aguaclara.design.pipeline.PipelineComponent method)
(in module aguaclara.core.physchem)
headloss_channel() (in module aguaclara.core.physchem)
headloss_ergun() (in module aguaclara.core.physchem)
headloss_exp() (in module aguaclara.core.physchem)
headloss_exp_general() (in module aguaclara.core.physchem)
headloss_exp_rect() (in module aguaclara.core.physchem)
headloss_fric() (in module aguaclara.core.physchem)
headloss_fric_general() (in module aguaclara.core.physchem)
headloss_fric_rect() (in module aguaclara.core.physchem)
headloss_gen() (in module aguaclara.core.physchem)
headloss_kozeny() (in module aguaclara.core.physchem)
headloss_major_channel() (in module aguaclara.core.physchem)
headloss_major_pipe() (in module aguaclara.core.physchem)
headloss_major_rect() (in module aguaclara.core.physchem)
headloss_manifold() (in module aguaclara.core.physchem)
headloss_minor_channel() (in module aguaclara.core.physchem)
headloss_minor_elbow() (in module aguaclara.core.physchem)
headloss_minor_pipe() (in module aguaclara.core.physchem)
headloss_minor_rect() (in module aguaclara.core.physchem)
headloss_pipe() (in module aguaclara.core.physchem)
headloss_pipeline (aguaclara.design.pipeline.PipelineComponent property)
headloss_rect() (in module aguaclara.core.physchem)
headloss_weir() (in module aguaclara.core.physchem)
headloss_weir_rect() (in module aguaclara.core.physchem)
height_water_critical() (in module aguaclara.core.physchem)
HumicAcid (in module aguaclara.research.floc_model)
I
ID_colored_tube() (in module aguaclara.research.peristaltic_pump)
id_sch() (aguaclara.core.pipes.Pipe method)
ID_sch() (in module aguaclara.core.pipes)
id_sch40 (aguaclara.core.pipes.Pipe property)
id_sdr (aguaclara.core.pipes.Pipe property)
ID_SDR() (in module aguaclara.core.pipes)
ID_SDR_all_available() (aguaclara.design.pipeline.Pipe method)
(in module aguaclara.core.pipes)
inlet_depth (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_drain_box_w (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_h (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_hl_max (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_last_coupling_h (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_man_h (aguaclara.design.sed_tank.SedimentationTank property)
inlet_man_nd (aguaclara.design.sed_tank.SedimentationTank property)
inlet_man_v_max (aguaclara.design.sed_tank.SedimentationTank property)
inlet_slope_l (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_step_h (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_w (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_w_post_weir (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_w_pre_weir (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_weir_h (aguaclara.design.sed_chan.SedimentationChannel property)
inlet_weir_hl (aguaclara.design.sed_chan.SedimentationChannel property)
intersect() (in module aguaclara.research.procoda_parser)
invpH() (in module aguaclara.research.environmental_processes_analysis)
iplot_columns() (in module aguaclara.research.procoda_parser)
J
JET_PLANE_RATIO (in module aguaclara.core.constants)
JET_ROUND_RATIO (in module aguaclara.core.constants)
K
K_KOZENY (in module aguaclara.core.constants)
L
l (aguaclara.design.ent.EntranceTank property)
(aguaclara.design.sed_chan.SedimentationChannel property)
l_max_vol (aguaclara.design.floc.Flocculator property)
LFOM (class in aguaclara.design.lfom)
list_handler() (in module aguaclara.core.utility)
M
M_stock() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
makePipe_minID_SDR() (in module aguaclara.core.pipes)
makePipe_ND_SDR() (in module aguaclara.core.pipes)
manifold_id_alt() (in module aguaclara.core.physchem)
Material (class in aguaclara.research.floc_model)
max() (in module aguaclara.core.utility)
min() (in module aguaclara.core.utility)
module
aguaclara.core.constants
aguaclara.core.drills
aguaclara.core.materials
aguaclara.core.physchem
aguaclara.core.pipes
aguaclara.core.units
aguaclara.core.utility
aguaclara.design.cdc
aguaclara.design.component
aguaclara.design.ent
aguaclara.design.ent_floc
aguaclara.design.floc
aguaclara.design.lfom
aguaclara.design.pipeline
aguaclara.design.sed
aguaclara.design.sed_chan
aguaclara.design.sed_tank
aguaclara.research.environmental_processes_analysis
aguaclara.research.floc_model
aguaclara.research.peristaltic_pump
aguaclara.research.procoda_parser
MOLEC_WEIGHT_ALUMINUM (in module aguaclara.research.floc_model)
moles_aluminum() (in module aguaclara.research.floc_model)
N
ND_all_available() (in module aguaclara.core.pipes)
ND_available() (in module aguaclara.core.pipes)
ND_SDR_available() (in module aguaclara.core.pipes)
notes() (in module aguaclara.research.procoda_parser)
nu (aguaclara.design.pipeline.PipelineComponent property)
NUM_AVOGADRO (in module aguaclara.research.floc_model)
num_coll_reqd() (in module aguaclara.research.floc_model)
num_nanoclusters() (in module aguaclara.research.floc_model)
num_orifices() (in module aguaclara.core.physchem)
O
O2_sat() (in module aguaclara.research.environmental_processes_analysis)
obstacle_n (aguaclara.design.floc.Flocculator property)
obstacle_pipe_od (aguaclara.design.floc.Flocculator property)
od (aguaclara.core.pipes.Pipe property)
(aguaclara.design.pipeline.Pipe property)
OD() (in module aguaclara.core.pipes)
OD_all_available() (in module aguaclara.core.pipes)
OD_available() (in module aguaclara.core.pipes)
OD_SDR() (in module aguaclara.core.pipes)
optional_units() (in module aguaclara.core.utility)
orifice_d (aguaclara.design.lfom.LFOM property)
orifice_d_max (aguaclara.design.lfom.LFOM property)
orifice_h_per_row (aguaclara.design.lfom.LFOM property)
orifice_n_max_per_row (aguaclara.design.lfom.LFOM property)
orifice_n_per_row (aguaclara.design.lfom.LFOM property)
outlet_depth (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_drain_box_w (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_man_nd (aguaclara.design.sed_tank.SedimentationTank property)
outlet_man_orifice_d (aguaclara.design.sed_tank.SedimentationTank property)
outlet_man_orifice_n (aguaclara.design.sed_tank.SedimentationTank property)
outlet_man_orifice_q (aguaclara.design.sed_tank.SedimentationTank property)
outlet_man_orifice_spacing (aguaclara.design.sed_tank.SedimentationTank property)
outlet_orifice_hl (aguaclara.design.sed_tank.SedimentationTank property)
outlet_pipe_n (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_pipe_q_max (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_post_weir_w (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_w (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_w_pre_weir (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_weir_depth (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_weir_h (aguaclara.design.sed_chan.SedimentationChannel property)
outlet_weir_hl (aguaclara.design.sed_chan.SedimentationChannel property)
P
PACl (in module aguaclara.research.floc_model)
pacl_nu() (aguaclara.design.cdc.CDC method)
pacl_term() (in module aguaclara.research.floc_model)
particle_number_concentration() (in module aguaclara.research.floc_model)
perform_function_on_state() (in module aguaclara.research.procoda_parser)
PHI_FLOC (in module aguaclara.research.floc_model)
Pipe (class in aguaclara.core.pipes)
(class in aguaclara.design.pipeline)
pipe_a_min (aguaclara.design.lfom.LFOM property)
pipe_ID() (in module aguaclara.core.physchem)
pipe_nd (aguaclara.design.lfom.LFOM property)
PipelineComponent (class in aguaclara.design.pipeline)
plate_l (aguaclara.design.ent.EntranceTank property)
(aguaclara.design.sed_tank.SedimentationTank property)
plate_n (aguaclara.design.ent.EntranceTank property)
plot_columns() (in module aguaclara.research.procoda_parser)
print_properties() (aguaclara.design.component.Component method)
PVC_PIPE_ROUGH (in module aguaclara.core.materials)
Q
q_per_row (aguaclara.design.lfom.LFOM property)
Q_stock() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
q_submerged() (aguaclara.design.lfom.LFOM method)
Q_sys() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
q_tank (aguaclara.design.sed_tank.SedimentationTank property)
R
radius_hydraulic() (in module aguaclara.core.physchem)
radius_hydraulic_channel() (in module aguaclara.core.physchem)
radius_hydraulic_general() (in module aguaclara.core.physchem)
radius_hydraulic_rect() (in module aguaclara.core.physchem)
ratio_area_clay_total() (in module aguaclara.research.floc_model)
ratio_clay_sphere() (in module aguaclara.research.floc_model)
RATIO_HEIGHT_DIAM (in module aguaclara.research.floc_model)
RATIO_KOLMOGOROV (in module aguaclara.research.floc_model)
re_channel() (in module aguaclara.core.physchem)
re_ergun() (in module aguaclara.core.physchem)
re_general() (in module aguaclara.core.physchem)
re_pipe() (in module aguaclara.core.physchem)
re_rect() (in module aguaclara.core.physchem)
RE_TRANSITION_PIPE (in module aguaclara.core.physchem)
read_state() (in module aguaclara.research.procoda_parser)
read_state_with_metafile() (in module aguaclara.research.procoda_parser)
REBAR_D (in module aguaclara.core.materials)
remove_notes() (in module aguaclara.research.procoda_parser)
retention_time (aguaclara.design.floc.Flocculator property)
round_sf() (in module aguaclara.core.utility)
round_step() (in module aguaclara.core.utility)
row_b (aguaclara.design.lfom.LFOM property)
row_n (aguaclara.design.lfom.LFOM property)
rpm() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
S
SCH (class in aguaclara.core.pipes)
sch() (aguaclara.core.pipes.Pipe method)
SCH_all_available() (in module aguaclara.core.pipes)
SedimentationChannel (class in aguaclara.design.sed_chan)
SedimentationTank (class in aguaclara.design.sed_tank)
Sedimentor (class in aguaclara.design.sed)
sep_dist_aluminum() (in module aguaclara.research.floc_model)
sep_dist_clay() (in module aguaclara.research.floc_model)
sep_dist_floc() (in module aguaclara.research.floc_model)
serialize_properties() (aguaclara.design.component.Component method)
set_sig_figs() (in module aguaclara.core.units)
set_subcomponents() (aguaclara.design.component.Component method)
side_slopes_h (aguaclara.design.sed_tank.SedimentationTank property)
side_slopes_w (aguaclara.design.sed_tank.SedimentationTank property)
socket_depth() (in module aguaclara.core.pipes)
Solver_AD_Pe() (in module aguaclara.research.environmental_processes_analysis)
Solver_CMFR_N() (in module aguaclara.research.environmental_processes_analysis)
stout_w_per_flow() (aguaclara.design.lfom.LFOM method)
T
T_stock() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
tank_n (aguaclara.design.sed.Sedimentor property)
Tee (class in aguaclara.design.pipeline)
time_col_laminar() (in module aguaclara.research.floc_model)
time_col_turbulent() (in module aguaclara.research.floc_model)
time_res_tube() (in module aguaclara.research.floc_model)
top_row_orifice_a (aguaclara.design.lfom.LFOM property)
Tracer_AD_Pe() (in module aguaclara.research.environmental_processes_analysis)
Tracer_CMFR_N() (in module aguaclara.research.environmental_processes_analysis)
V
V_super_stock() (aguaclara.research.stock_qc.Variable_C_Stock method)
(aguaclara.research.stock_qc.Variable_Q_Stock method)
Variable_C_Stock (class in aguaclara.research.stock_qc)
Variable_Q_Stock (class in aguaclara.research.stock_qc)
VC_ORIFICE_RATIO (in module aguaclara.core.constants)
vel_critical (aguaclara.design.lfom.LFOM property)
vel_grad_avg (aguaclara.design.floc.Flocculator property)
vel_horizontal() (in module aguaclara.core.physchem)
vel_term_floc() (in module aguaclara.research.floc_model)
viscosity_dynamic() (in module aguaclara.core.physchem)
viscosity_dynamic_water() (in module aguaclara.core.physchem)
viscosity_kinematic() (in module aguaclara.core.physchem)
viscosity_kinematic_water() (in module aguaclara.core.physchem)
vol (aguaclara.design.floc.Flocculator property)
vol_per_rev_3_stop() (in module aguaclara.research.peristaltic_pump)
vol_per_rev_LS() (in module aguaclara.research.peristaltic_pump)
W
w_outer (aguaclara.design.sed_chan.SedimentationChannel property)
WATER_DENSITY (in module aguaclara.core.constants)
WATER_DENSITY_TABLE (in module aguaclara.core.physchem)
WATER_NU (in module aguaclara.core.constants)
width_rect_weir() (in module aguaclara.core.physchem)
width_weir_rect() (in module aguaclara.core.physchem)
write_calculations_to_csv() (in module aguaclara.research.procoda_parser)
write_properties_to_file() (aguaclara.design.component.Component method)