Auxiliary Fluid Functions¶
There are some functions for auxiliary purposes which are listed in the following:
Get the fluid that is used in an existing network:
-
get_fluid(net)¶ This function shows which fluid is used in the net.
- Parameters
net (pandapipesNet) – Current network
- Returns
Fluid - Name of the fluid which is used in the current network
- Return type
Create a fluid with only constant properties:
-
create_constant_fluid(name=None, fluid_type=None, \*\*kwargs)¶ Creates a constant fluid.
- Parameters
name (str) – Name of the fluid
fluid_type (str) – Type of the fluid
kwargs – Additional information
- Returns
Fluid
- Return type
Create a constant property and add it to the fluid used in a network:
-
create_constant_property(net, property_name, value, overwrite=True, warn_on_duplicates=True)¶ Creates a property with a constant value.
- Parameters
net (pandapipesNet) – Name of the network to which the property is added
property_name (str) – Name of the new property
value (float) – Constant value of the property
overwrite (basestring) – True if existing property with the same name shall be overwritten
warn_on_duplicates (basestring) – True, if a warning of properties with the same name should be returned
Create a property with linear correlation and add it to the fluid used in a network:
-
create_linear_property(net, property_name, slope, offset, overwrite=True, warn_on_duplicates=True)¶ Creates a property with a linear correlation.
- Parameters
net (pandapipesNet) – Name of the network to which the property is added
property_name (str) – Name of the new property
slope (float) – Slope of the linear correlation
offset (float) – Offset of the linear function
overwrite (basestring) – True if existing property with the same name shall be overwritten
warn_on_duplicates (basestring) – True, if a warning of properties with the same name should be returned