h2integrate.transporters.generic_splitter

h2integrate.transporters.generic_splitter#

Classes

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

Configuration class for the GenericSplitterPerformanceModel.

GenericSplitterPerformanceModel(**kwargs)

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

Configuration class for the GenericSplitterPerformanceModel.

Parameters:

  • split_mode (str)

  • commodity (str)

  • commodity_units (str)

  • fraction_to_priority_tech (float)

  • prescribed_commodity_to_priority_tech (float)

split_mode#

what method to use to split input commodity stream. Must be either "prescribed_commodity" or "fraction" to split commodity stream.

Type:

str

commodity#

name of commodity

Type:

str

commodity_units#

units of commodity production profile

Type:

str

fraction_to_priority_tech#

fraction of input commodity to send to first output stream. Only used if split_mode is "fraction". Defaults to None.

Type:

float, optional

prescribed_commodity_to_priority_tech#

constant amount of input commodity to send to first output stream in same units as commodity_units. Only used if split_mode is "prescribed_commodity". Defaults to None.

Type:

float, optional

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

Split commodity from one source into two outputs.

This component supports two splitting modes: 1. Fraction-based splitting: Split based on a specified fraction sent to the priority technology 2. Prescribed commodity splitting: Send a prescribed amount to the priority technology,

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.

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