h2integrate.transporters.generic_splitter

h2integrate.transporters.generic_splitter#

Classes

GenericSplitterPerformanceConfig(*, ...[, ...])

Configuration class for the GenericSplitterPerformanceModel.

GenericSplitterPerformanceModel(**kwargs)

Split a commodity stream from one source into two outputs.
class h2integrate.transporters.generic_splitter.GenericSplitterPerformanceConfig(*, split_mode, commodity, commodity_rate_units, fraction_to_priority_tech=None, prescribed_commodity_to_priority_tech=None)#

Configuration class for the GenericSplitterPerformanceModel.

Fields include split_mode, commodity, commodity_rate_units, fraction_to_priority_tech, and prescribed_commodity_to_priority_tech.

Parameters:

  • split_mode (str)

  • commodity (str)

  • commodity_rate_units (str)

  • fraction_to_priority_tech (float)

  • prescribed_commodity_to_priority_tech (float)

split_mode: str#
commodity: str#
commodity_rate_units: str#
fraction_to_priority_tech: float#
prescribed_commodity_to_priority_tech: float#
class h2integrate.transporters.generic_splitter.GenericSplitterPerformanceModel(**kwargs)#

Split a commodity stream from one source into two outputs.

This component supports two splitting modes:

  • Fraction-based splitting: split based on a specified fraction sent to the

    priority technology.

  • Prescribed commodity splitting: send a prescribed amount to the priority

    technology, with the remainder to the other technology.

The priority_tech parameter determines which technology receives the primary allocation. The outputs are:

  • {commodity}_out1: commodity sent to the first technology.

  • {commodity}_out2: commodity sent to the second technology.

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

_time_step_bounds = (1, 1000000000.0)#
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.