h2integrate.converters.natural_gas.dummy_gas_components

Contents

h2integrate.converters.natural_gas.dummy_gas_components#

Dummy components for demonstrating multivariable streams, nominally based on wellhead gas mixtures. These components are not meant to represent any real physical processes or technologies, but simply to provide a realistic example of producing and consuming a multivariable stream with multiple constituent variables.

These components are used in example 32 to showcase the multivariable stream connection feature. They produce and consume wellhead_gas_mixture streams with 5 constituent variables.

Classes

SimpleGasConsumerCost(**kwargs)

Simple cost model for the dummy gas consumer.

SimpleGasConsumerCostConfig(*, cost_year[, ...])

Configuration class for dummy gas consumer cost model.

SimpleGasConsumerPerformance(**kwargs)

A dummy gas consumer component that takes in a 'wellhead_gas_mixture' multivariable stream.

SimpleGasProducerCost(**kwargs)

Simple cost model for the dummy gas producer.

SimpleGasProducerCostConfig(*, cost_year[, ...])

Configuration class for dummy gas producer cost model.

SimpleGasProducerPerformance(**kwargs)

A dummy gas producer component that outputs a 'wellhead_gas_mixture' multivariable stream.

SimpleGasProducerPerformanceConfig(*[, ...])

Configuration class for dummy gas producer performance model.

class h2integrate.converters.natural_gas.dummy_gas_components.SimpleGasProducerPerformanceConfig(*, base_flow_rate=100.0, base_temperature=300.0, base_pressure=10.0, flow_variation=20.0, temp_variation=10.0, pressure_variation=1.0, random_seed=None)#

Configuration class for dummy gas producer performance model.

Parameters:
  • base_flow_rate (float)

  • base_temperature (float)

  • base_pressure (float)

  • flow_variation (float)

  • temp_variation (float)

  • pressure_variation (float)

  • random_seed (int | None)

base_flow_rate#

Base gas flow rate in kg/h

Type:

float

base_temperature#

Base gas temperature in K

Type:

float

base_pressure#

Base gas pressure in bar

Type:

float

flow_variation#

Absolute variation in flow rate in kg/h

Type:

float

temp_variation#

Variation in temperature in K

Type:

float

pressure_variation#

Variation in pressure in bar

Type:

float

random_seed#

Seed for random number generator (for reproducibility)

Type:

int | None

base_flow_rate: float#
base_temperature: float#
base_pressure: float#
flow_variation: float#
temp_variation: float#
pressure_variation: float#
random_seed: int | None#
class h2integrate.converters.natural_gas.dummy_gas_components.SimpleGasProducerPerformance(**kwargs)#

A dummy gas producer component that outputs a ‘wellhead_gas_mixture’ multivariable stream.

This component produces time-varying outputs for each constituent variable of the wellhead_gas_mixture stream (mass_flow, hydrogen_mass_fraction, oxygen_mass_fraction, temperature, pressure).

The outputs use random variations around base values.

_time_step_bounds = (3600, 3600)#
initialize()#

Perform any one-time initialization run at instantiation.

setup()#

Declare inputs and outputs.

Available attributes:

name pathname comm options

compute(inputs, outputs)#

Computation for the OM component.

For a template class this is not implement and raises an error.

class h2integrate.converters.natural_gas.dummy_gas_components.SimpleGasConsumerPerformance(**kwargs)#

A dummy gas consumer component that takes in a ‘wellhead_gas_mixture’ multivariable stream.

This component demonstrates receiving all constituent variables of a wellhead_gas_mixture stream (mass_flow, hydrogen_mass_fraction, oxygen_mass_fraction, temperature, pressure) and performing simple calculations.

The component calculates some derived quantities from the input stream. The primary commodity output is hydrogen (extracted from the gas stream).

_time_step_bounds = (3600, 3600)#
initialize()#

Perform any one-time initialization run at instantiation.

setup()#

Declare inputs and outputs.

Available attributes:

name pathname comm options

compute(inputs, outputs)#

Computation for the OM component.

For a template class this is not implement and raises an error.

class h2integrate.converters.natural_gas.dummy_gas_components.SimpleGasProducerCostConfig(*, cost_year, capex=1000000.0, opex=50000.0)#

Configuration class for dummy gas producer cost model.

Parameters:
  • cost_year (int)

  • capex (float)

  • opex (float)

capex#

Capital expenditure in USD

Type:

float

opex#

Fixed operational expenditure in USD/year

Type:

float

capex: float#
opex: float#
class h2integrate.converters.natural_gas.dummy_gas_components.SimpleGasProducerCost(**kwargs)#

Simple cost model for the dummy gas producer.

_time_step_bounds = (3600, 3600)#
setup()#

Declare inputs and outputs.

Available attributes:

name pathname comm options

compute(inputs, outputs, discrete_inputs=None, discrete_outputs=None)#

Computation for the OM component.

For a template class this is not implement and raises an error.

class h2integrate.converters.natural_gas.dummy_gas_components.SimpleGasConsumerCostConfig(*, cost_year, capex=2000000.0, opex=100000.0)#

Configuration class for dummy gas consumer cost model.

Parameters:
  • cost_year (int)

  • capex (float)

  • opex (float)

capex#

Capital expenditure in USD

Type:

float

opex#

Fixed operational expenditure in USD/year

Type:

float

capex: float#
opex: float#
class h2integrate.converters.natural_gas.dummy_gas_components.SimpleGasConsumerCost(**kwargs)#

Simple cost model for the dummy gas consumer.

_time_step_bounds = (3600, 3600)#
setup()#

Declare inputs and outputs.

Available attributes:

name pathname comm options

compute(inputs, outputs, discrete_inputs=None, discrete_outputs=None)#

Computation for the OM component.

For a template class this is not implement and raises an error.