|
The Brown Book
Documentation for the PooPyLab project
|
|
|
The Brown Book
Documentation for the PooPyLab project
|
|
Conceptual definition of common interface. More...
Public Member Functions | |
| def | set_flow_data_src (self, branch, flow_ds) |
| Set the flow data source of the selected branch. | |
| def | get_flow_data_src (self) |
| Get the flow data source tags of the unit. | |
| def | assign_initial_guess (self, init_guess_lst) |
| Assign the intial guess to the unit before simulation. | |
| def | is_converged (self, limit) |
| Return the convergence status of the unit. | |
| def | get_type (self) |
| Return the type of the current object. | |
| def | has_sidestream (self) |
| Check if the current unit has a sidestream discharge. More... | |
| def | add_upstream (self, discharger, branch) |
| Add the discharger's branch to inlet. | |
| def | has_discharger (self) |
| Return True if upstream is connected, False if not. | |
| def | get_upstream (self) |
| def | totalize_inflow (self) |
| Combine the individual flows specified in the self._inlet into one. | |
| def | blend_inlet_comps (self) |
| Calculate the flow weighted average model component concentrations. More... | |
| def | update_combined_input (self) |
| Update both the flows and loads for the current unit. | |
| def | remove_upstream (self, discharger) |
| Remove an existing discharger from inlet. | |
| def | set_downstream_main (self, receiver) |
| Define the main outlet by specifying the receiving process unit. | |
| def | main_outlet_connected (self) |
| Return whether the main outlet of the unit is defined (connected). | |
| def | get_downstream_main (self) |
| Return the process unit that is connected to the main outlet. | |
| def | set_mainstream_flow_by_upstream (self, flag) |
| Set whether the mainstream flow = (total inflow - side outflow). | |
| def | set_mainstream_flow (self, flow) |
| Define the mainstream outlet flow. | |
| def | get_main_outflow (self) |
| Return the mainstream outlet flow. | |
| def | get_main_outlet_concs (self) |
| Return a copy of the mainstream outlet concentrations. | |
| def | set_downstream_side (self, receiver) |
| Define the downstream side outlet's connection. | |
| def | side_outlet_connected (self) |
| Return True if the main outlet is connected, False if not. | |
| def | get_downstream_side (self) |
| Return the process unit connected to the side outlet. | |
| def | set_sidestream_flow (self, flow) |
| Define the flow rate for the sidestream. | |
| def | sidestream_flow_defined (self) |
| Return whether the sidestream flow rate has been defined. | |
| def | get_side_outflow (self) |
| Return the sidestream outlet flow rate. | |
| def | get_side_outlet_concs (self) |
| Return a copy of the sidestream outlet concentrations. | |
| def | set_flow (self, discharger, flow) |
| Specify the flow from the discharger. | |
| def | discharge (self) |
| Pass the total flow and blended components to the downstreams. | |
| def | get_TSS (self, branch='Main') |
| Return the Total Suspended Solids of the specified branch. | |
| def | get_VSS (self, branch='Main') |
| Return the Volatile Suspended Solids of the specified branch. | |
| def | get_COD (self, branch='Main') |
| Return the Chemical Oxygen Demand (total) of the specified branch. | |
| def | get_sCOD (self, branch='Main') |
| Return the soluble COD of the specified branch. | |
| def | get_pCOD (self, branch='Main') |
| Return the particultate COD of the specified branch. | |
| def | get_TN (self, branch='Main') |
| Return the total nitrogen of the specified branch. | |
| def | get_orgN (self, branch='Main') |
| Return the organic nitrogen of the specified branch. | |
| def | get_inorgN (self, branch='Main') |
| Return the inorganic nitrogen of the specified branch. | |
| def | get_pN (self, branch='Main') |
| Return the particulate nitrogen of the specified branch. | |
| def | get_sN (self, branch='Main') |
| Return the soluble nitrogen of the specified branch. | |
Private Member Functions | |
| def | _discharge_main_outlet (self) |
| Pass the flow and concentrations to the main outlet. | |
| def | _discharge_side_outlet (self) |
| Pass the flow and concentrations to the side outlet. | |
| def | _branch_flow_helper (self) |
| Calculate 1 of the 3 branches' flow based on the other 2. | |
| def | _check_conc_cnvg (self, curr_comps, prev_comps, rel_lim) |
| Check the convergence of model components (concentrations). | |
Static Private Attributes | |
| __metaclass__ = ABCMeta | |
Conceptual definition of common interface.
| def PooPyLab.unit_procs.base.poopy_lab_obj.has_sidestream | ( | self | ) |
Check if the current unit has a sidestream discharge.
Default = True, i.e. splitter always has a sidestream.
Reimplemented in PooPyLab.unit_procs.streams.splitter.
| def PooPyLab.unit_procs.base.poopy_lab_obj.blend_inlet_comps | ( | self | ) |
Calculate the flow weighted average model component concentrations.
Reimplemented in PooPyLab.unit_procs.streams.influent, and PooPyLab.unit_procs.streams.splitter.
1.8.20