business.gravity.arrangements package¶
Define the hydraulic problems for a ‘gravity’ water supply.
Submodules¶
business.gravity.arrangements.base module¶
Define a gravity-fed dendridic network, with all common features to both the hydraulic design and hydraulic check problems.
-
class
business.gravity.arrangements.base.
BaseGravity
(**kwargs)¶ Bases:
business.commons.loggers.InitLogger
,business.gravity.views.plots.PlotGravityMixin
A class used to represent a gravity-fed dendridic water supply.
Functionality: provides the dendridic topology of its trunks. Provides also base tree concepts such as: the calculation of the water flow.
Notes
Ancestor of
GravityCheck
andGravityDesign
. Subclasses GravityChech and Gravity Design differ since they implement the equations that describe the ‘hydraulic check’ and ‘hydraulic design’ problems respectvely.
business.gravity.arrangements.check module¶
Define the ‘hydraulic check problem’ for a ‘gravity’ water supply .
-
class
business.gravity.arrangements.check.
GravityCheck
(**kwargs)¶ Bases:
business.gravity.solvers.check.DendridicCheckMixin
,business.gravity.mixins.energy.CheckEnergyNetworkMixin
,business.gravity.mixins.topology.CheckTrunksNetworkMixin
,business.gravity.mixins.zoning.ZoningMixin
,business.gravity.views.reports.GravityCheckReportMixin
,business.tests.gravity.utils.GravityCheckTestMixin
,business.gravity.arrangements.base.BaseGravity
Represent the ‘hydraulic check problem’ of a ‘gravity’ water supply.
Functionality: define and solve the mathematical equations that solve the ‘hydarulic check problem’ of a gravity-fed dendridic water supply.
- Parameters
trunks (iterable[TrunkCheck]) – the collection of
TrunkCheck
instances. The collection describes the dendridic topology of the water supply.intake_elevation (Quantity(length)) – the elevation above the sea level of the point where water is abstracted from a natural source and sent into the dendridic tree.
-
solve_hydraulic_check_problem
()¶ solves the ‘’hydarulic check problem’’ equations.
Notes
The water supply is composed of: * a spring * a dendridic network of conduits where water flow is constant * The water flow is entirely gravity driven. * The water flow is determined purely by the gravity force; therefore there are no pressure reducing valves in the entire water supply.
The model of the water supply is composed of: * the sequence of trunks whch represent the dendridic network. * Trunks are topologically the nodes of a tree. * The tree is represented by the adjacnecy list of each trunk. Remark that: * the trunks play the role of topological ‘nodes’ of a tree; they are not ‘edges’. The tree is composed of nodes without the need of introducing edges. * each Trunk has a set of attributes, prefiex by, ‘tail’ and ‘head’ that refer to properties of the two ends of the pipeline.
business.gravity.arrangements.design module¶
Define the ‘hydraulic design problem’ for a ‘gravity’ water supply .
-
class
business.gravity.arrangements.design.
GravityDesign
(**kwargs)¶ Bases:
business.gravity.mixins.flows.FlowDesignMixin
,business.gravity.mixins.energy.EnergyDesignMixin
,business.gravity.mixins.topology.DesignTrunksNetworkMixin
,business.gravity.mixins.zoning.ZoningMixin
,business.gravity.solvers.design.GravityDesignMixin
,business.gravity.views.reports.GravityDesignReportMixin
,business.tests.gravity.utils.GravityDesignTestMixin
,business.gravity.arrangements.base.BaseGravity
Represent the gravity-fed dendridic water supply, modelled to solve the ‘hydarulic check problem’.
Functionality: define and solve the mathematical equations that solve the ‘hydarulic design problem’ of a gravity-fed dendridic water supply.
Note
Physical characteristic of the system. A typical rural gravity-fed scheme has a simple topology: the source is a spring. From there water flows by gravity to a main tank. Downstream of the tank a distribution system is laid down, which is generally branched instead of looped as fire flows and redundancy of distribution are not major concerns.
The branched mains deliver water to the villages reservoirs and typically follow the general topology of valleys and position of villages. In a branched system, also called tree, the water has only one possible path from the source to a village reservoir.
Service lines transmit the water from the village reservoirs to the end customers (public fountains, water troughs for cattle….)
-
solve_hydraulic_design_problem
()¶ solve the hydarulic design problem and set the results in the calculations report.
-
class
DesignSolutionDetails
(treatment: Any = None, trunks: Tuple[business.gravity.trunks.TrunkDesign] = None)¶ Bases:
tuple
The report of the technical calculations from the solution of the hydraulIC design problem.
-
treatment
¶ futures: treatment may be implemented in a future version of this software package
-
trunks
¶ maps every trunk of the dendridic network to the trunk’s report of its ‘hydraulic design problem’.
- Type
dictionary
-
property
treatment
¶ Alias for field number 0
-
property
trunks
¶ Alias for field number 1
-
-