tespy.components.basics package

tespy.components.basics.cycle_closer module

Module for class CycleCloser

This file is part of project TESPy (github.com/oemof/tespy). It’s copyrighted by the contributors recorded in the version control history of the file, available from its original location tespy/components/basics/cycle_closer.py

SPDX-License-Identifier: MIT

class tespy.components.basics.cycle_closer.CycleCloser(label, **kwargs)

Bases: Component

Component for closing cycles.

Ports

• Fluid inlets: in1

• Fluid outlets: out1

Mandatory Equations

• pressure equality constraint: variable_equality_structure_matrix

• enthalpy equality constraint: variable_equality_structure_matrix

Parameters:

• char_warnings (bool) – Ignore warnings on default characteristics usage for this component.

• design (list) – List containing design parameters (stated as String).

• design_path (str) – Path to the components design case.

• fluid_deviation (float, dict) – Norm of absolute deviation of fluid composition between inlet and outlet.

• label (str) – The label of the component.

• local_design (bool) – Treat this component in design mode in an offdesign calculation.

• local_offdesign (bool) – Treat this component in offdesign mode in a design calculation.

• mass_deviation (float, dict) – Absolute deviation of mass flow between inlet and outlet. Quantity: mass_flow.

• offdesign (list) – List containing offdesign parameters (stated as String).

• printout (bool) – Include this component in the network’s results printout.

Notes

Note

This component can be used to close a cycle process. The system of equations describing your plant will overdetermined, if you close a cycle without this component or a cut the cycle with a sink and a source at some point of the cycle. This component can be used instead of cutting the cycle.

Example

Create a cycle containing a pump and a pipe. The pump increases pressure the pipe cools the liquid and destroys the pressure rise. The heat extracted at the pipe must be the same value of the power input at the pump (but negative), as there is no other in- or outputs of energy in the system.

>>> from tespy.components import CycleCloser, Pipe, Pump
>>> from tespy.connections import Connection
>>> from tespy.networks import Network
>>> nw = Network(iterinfo=False)
>>> nw.units.set_defaults(**{
...     "pressure": "bar", "pressure_difference": "bar",
...     "temperature": "degC"
... })
>>> pi = Pipe('pipe')
>>> pu = Pump('pump')
>>> cc = CycleCloser('cycle closing component')
>>> pu_pi = Connection(pu, 'out1', pi, 'in1')
>>> pi_cc = Connection(pi, 'out1', cc, 'in1')
>>> cc_pu = Connection(cc, 'out1', pu, 'in1')
>>> nw.add_conns(pu_pi, pi_cc, cc_pu)
>>> pi_cc.set_attr(p=1, T=20, fluid={'water': 1})
>>> pu_pi.set_attr(p=10)
>>> pu.set_attr(eta_s=0.8, P=1000)
>>> nw.solve('design')
>>> round(pi.Q.val, 1) == -round(pu.P.val, 1)
True

get_mandatory_constraints()

get_parameters()

static inlets()

static outlets()

propagate_wrapper_to_target(branch)

start_fluid_wrapper_branch()

tespy.components.basics.sink module

Module for class Sink.

This file is part of project TESPy (github.com/oemof/tespy). It’s copyrighted by the contributors recorded in the version control history of the file, available from its original location tespy/components/basics/sink.py

SPDX-License-Identifier: MIT

class tespy.components.basics.sink.Sink(label, **kwargs)

Bases: Component

A flow drains in a Sink.

Ports

• Fluid inlets: in1

Mandatory Equations

None

Parameters:

• char_warnings (bool) – Ignore warnings on default characteristics usage for this component.

• design (list) – List containing design parameters (stated as String).

• design_path (str) – Path to the components design case.

• label (str) – The label of the component.

• local_design (bool) – Treat this component in design mode in an offdesign calculation.

• local_offdesign (bool) – Treat this component in offdesign mode in a design calculation.

• offdesign (list) – List containing offdesign parameters (stated as String).

• printout (bool) – Include this component in the network’s results printout.

Example

Create a sink and specify a label.

>>> from tespy.components import Sink
>>> si = Sink('a labeled sink')
>>> si.label
'a labeled sink'

static get_mandatory_constraints()

static inlets()

propagate_wrapper_to_target(branch)

tespy.components.basics.source module

Module for class Source.

This file is part of project TESPy (github.com/oemof/tespy). It’s copyrighted by the contributors recorded in the version control history of the file, available from its original location tespy/components/basics/source.py

SPDX-License-Identifier: MIT

class tespy.components.basics.source.Source(label, **kwargs)

Bases: Component

A flow originates from a Source.

Ports

• Fluid outlets: out1

Mandatory Equations

None

Parameters:

• char_warnings (bool) – Ignore warnings on default characteristics usage for this component.

• design (list) – List containing design parameters (stated as String).

• design_path (str) – Path to the components design case.

• label (str) – The label of the component.

• local_design (bool) – Treat this component in design mode in an offdesign calculation.

• local_offdesign (bool) – Treat this component in offdesign mode in a design calculation.

• offdesign (list) – List containing offdesign parameters (stated as String).

• printout (bool) – Include this component in the network’s results printout.

Example

Create a source and specify a label.

>>> from tespy.components import Source
>>> so = Source('a labeled source')
>>> so.label
'a labeled source'

static get_mandatory_constraints()

static outlets()

start_fluid_wrapper_branch()

tespy.components.basics.subsystem_interface module

Module for class SubsystemInterface.

This file is part of project TESPy (github.com/oemof/tespy). It’s copyrighted by the contributors recorded in the version control history of the file, available from its original location tespy/components/basics/subsystem_interface.py

SPDX-License-Identifier: MIT

class tespy.components.basics.subsystem_interface.SubsystemInterface(label, **kwargs)

Bases: Component

The subsystem interface does not change fluid properties.

Ports

• Fluid inlets: in1, in2, … (variable, count set by num_inter)

• Fluid outlets: out1, out2, … (variable, count set by num_inter)

Mandatory Equations

• mass flow equality constraint(s): variable_equality_structure_matrix

• fluid composition equality constraint(s): variable_equality_structure_matrix

• pressure equality constraint: variable_equality_structure_matrix

• enthalpy equality constraint: variable_equality_structure_matrix

Parameters:

• char_warnings (bool) – Ignore warnings on default characteristics usage for this component.

• design (list) – List containing design parameters (stated as String).

• design_path (str) – Path to the components design case.

• label (str) – The label of the component.

• local_design (bool) – Treat this component in design mode in an offdesign calculation.

• local_offdesign (bool) – Treat this component in offdesign mode in a design calculation.

• num_inter (int) – Number of interfacing connections.

• offdesign (list) – List containing offdesign parameters (stated as String).

• printout (bool) – Include this component in the network’s results printout.

Notes

Note

This component passes all fluid properties and mass flow from its inlet to the outlet.

Example

As connections can only connect a component with a different component, the subsystem interface is used to connect subsystems with the rest of your network. It is necessary to specify the number of interfaces of the subsystem interface, if you want any number other than 1. We will not go in depth of subsystem usage in this example. Please refer to this section for more information on building your own subsystems.

>>> from tespy.components import Sink, Source, SubsystemInterface
>>> from tespy.connections import Connection
>>> from tespy.networks import Network
>>> nw = Network(iterinfo=False)
>>> nw.units.set_defaults(**{
...     "pressure": "bar", "pressure_difference": "bar",
...     "temperature": "degC", "enthalpy": "kJ/kg"
... })
>>> so1 = Source('source 1')
>>> si1 = Sink('sink 1')
>>> so2 = Source('source 2')
>>> si2 = Sink('sink 2')
>>> IF = SubsystemInterface('subsystem interface', num_inter=2)
>>> len(IF.inlets())
2

The interface does not change the fluid properties in any way.

>>> inc1 = Connection(so1, 'out1', IF, 'in1')
>>> outg1 = Connection(IF, 'out1', si1, 'in1')
>>> inc2 = Connection(so2, 'out1', IF, 'in2')
>>> outg2 = Connection(IF, 'out2', si2, 'in1')
>>> nw.add_conns(inc1, outg1, inc2, outg2)
>>> inc1.set_attr(fluid={'H2O': 1}, T=40, p=3, m=100)
>>> inc2.set_attr(fluid={'N2': 1}, T=60, p=1)
>>> outg2.set_attr(v=10)
>>> nw.solve('design')
>>> inc1.m.val_SI == outg1.m.val_SI
True
>>> inc2.m.val_SI == outg2.m.val_SI
True
>>> inc1.h.val_SI == outg1.h.val_SI
True
>>> inc2.h.val_SI == outg2.h.val_SI
True

get_mandatory_constraints()

static get_parameters()

inlets()

outlets()

classmethod port_schema()

Return a description of the component’s port topology for UI tooling.

The default implementation derives fixed-port descriptions from the @staticmethod inlets/outlets/powerinlets/ poweroutlets methods. Subclasses with variable or conditional port counts must override this method.

Returns:

dict – Keys are "inlets", "outlets", "powerinlets", "poweroutlets", "heatinlets", "heatoutlets". Each value is a dict with at least a "type" key:

{"type": "fixed", "ports": [...]}

The port list is static.

{"type": "variable", "parameter": str, "pattern": str, "min": int}

Port count is controlled by parameter. pattern is a Python format string where {n} is replaced by the 1-based port index (e.g. "in{n}").