h2integrate.transporters.generic_combiner

h2integrate.transporters.generic_combiner#

Classes

GenericCombinerPerformanceConfig(*, ...[, ...])

Configuration class for a generic combiner.

GenericCombinerPerformanceModel(**kwargs)

Combine any commodity or resource from multiple sources into one output without losses.
class h2integrate.transporters.generic_combiner.GenericCombinerPerformanceConfig(*, commodity, commodity_rate_units, in_streams=2)#

Configuration class for a generic combiner.

Parameters:

  • commodity (str)

  • commodity_rate_units (str)

  • in_streams (int)

commodity#

name of commodity type

Type:

str

commodity_units#

units of commodity production profile

Type:

str

in_streams#

how many inflow streams will be connected, defaults to 2

Type:

int

commodity: str#
commodity_rate_units: str#
in_streams: int#
class h2integrate.transporters.generic_combiner.GenericCombinerPerformanceModel(**kwargs)#

Combine any commodity or resource from multiple sources into one output without losses.

This component is purposefully simple; a more realistic case might include losses or other considerations from system components.

The combined output capacity factor is computed as a weighted average of the input stream capacity factors, weighted by each stream’s rated production:

\[CF_{out} = \frac{\sum_i CF_i \cdot S_i}{\sum_i S_i}\]

where \(CF_i\) is the capacity factor and \(S_i\) is the rated commodity production of input stream i. If the total rated production is zero, the output capacity factor is set to zero.

The total rated production is the sum of all input rated productions, and the output commodity profile is the element-wise sum of all input profiles.

initialize()#

Perform any one-time initialization run at instantiation.

setup()#

Declare inputs and outputs.

Available attributes:

name pathname comm options

compute(inputs, outputs)#

Compute outputs given inputs. The model is assumed to be in an unscaled state.

An inherited component may choose to either override this function or to define a compute_primal function.

Parameters:

  • inputs (Vector) – Unscaled, dimensional input variables read via inputs[key].

  • outputs (Vector) – Unscaled, dimensional output variables read via outputs[key].

  • discrete_inputs (dict-like or None) – If not None, dict-like object containing discrete input values.

  • discrete_outputs (dict-like or None) – If not None, dict-like object containing discrete output values.

Contents