From 1256098e44a80048f553172206883653a8df9781 Mon Sep 17 00:00:00 2001 From: Francesco Witte Date: Thu, 25 Oct 2018 13:03:28 +0200 Subject: [PATCH] fixed some typos --- doc/getting_started/cogeneration_unit.rst | 3 ++- doc/using_tespy.rst | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/getting_started/cogeneration_unit.rst b/doc/getting_started/cogeneration_unit.rst index b6f3bc36e..c5a510c5e 100644 --- a/doc/getting_started/cogeneration_unit.rst +++ b/doc/getting_started/cogeneration_unit.rst @@ -12,10 +12,11 @@ TESPy provides a set of predefined characteristics (documented in the :py:class: Figure: Topology of a cogeneration unit. -The characteristics take the power ratio (:math:`\frac{P}{P_{ref}}` as argument. For a design case simulation the power ratio is always assumed to be equal to 1. +The characteristics take the power ratio (:math:`\frac{P}{P_{ref}}`) as argument. For a design case simulation the power ratio is always assumed to be equal to 1. For offdesign calculation TESPy will automatically take the rated power from the design case and use it to determine the power ratio. Still it is possible to specify the rated power manually, if you like. In contrast to other components, the cogeneration unit has several busses, which are accessible by specifying the corresponding bus parameter: + - TI (thermal input), - Q (total heat output), - Q1 and Q2 (heat output 1 and 2), diff --git a/doc/using_tespy.rst b/doc/using_tespy.rst index f4dd94c68..94f27934e 100644 --- a/doc/using_tespy.rst +++ b/doc/using_tespy.rst @@ -982,15 +982,17 @@ Offdesign calculations use the referenced value from your system design point fo .. note:: The available keywords for the dictionary are + - 'c' for the component instance, - 'p' for the parameter (the cogeneration unit has different parameters, have a look at the :ref:`cogeneration unit example `), - 'P_ref' for the reference heat flow/power value of the component and - 'char' for the characteristic line. There are different specification possibilites: + - If you specify the component only, the parameter will be default (not working with cogeneration unit) and the conversion factor of the characteristic line will be 1 for every load. - If you specify a numeric value for char, the conversion factor will be that value for every load. - - If you want to specify a characteristic line, you need to provide a :py:class:`Source ` object. + - If you want to specify a characteristic line, you need to provide a :py:class:`TESPy characteristics ` object. This can be used for easy post processing, e. g. to calculate thermal efficiency or you can build up relations between components in your network. If you want to use the busses for postprocessing only, you must not specify the sum of the power or heat flux on your bus.