AtnParamsBrickstorageheater

Python pydantic class corresponding to json type `atn.params.brickstorageheater`.

class gwatn.types.AtnParamsBrickstorageheater(*, GNodeAlias, HomeCity='MILLINOCKET_ME', TimezoneString='US/Eastern', StorageSteps=100, FloSlices=48, SliceDurationMinutes=60, CurrencyUnit=RecognizedCurrencyUnit.USD, Tariff=DistributionTariff.VersantA1StorageHeatTariff, EnergyType=EnergySupplyType.RealtimeLocalLmp, StandardOfferPriceDollarsPerMwh=110, DistributionTariffDollarsPerMwh=113, MaxBrickTempC=190, RatedMaxPowerKw=13.5, C=200, ROff=0.08, ROn=0.15, RoomTempF=70, AnnualHvacKwhTh=28125, BetaOt=158, TempUnit=RecognizedTemperatureUnit.F, AmbientPowerInKw=1.25, HouseWorstCaseTempF=-7, TypeName='atn.params.brickstorageheater', Version='000')

Params for a BrickStorageHeater Atn Strategy.

Parameters for a model of a ceramic brick thermal storage room unit, using a two-dimensional Dijstra graph parameterized by ‘fullness of the thermal battery’ and time. [More info](https://gridworks-atn.readthedocs.io/en/latest/brick-storage-heater.html).

Parameters:

  • GNodeAlias (str) –

  • HomeCity (str) –

  • TimezoneString (str) –

  • StorageSteps (int) –

  • FloSlices (int) –

  • SliceDurationMinutes (int) –

  • CurrencyUnit (RecognizedCurrencyUnit) –

  • Tariff (DistributionTariff) –

  • EnergyType (EnergySupplyType) –

  • StandardOfferPriceDollarsPerMwh (int) –

  • DistributionTariffDollarsPerMwh (int) –

  • MaxBrickTempC (int) –

  • RatedMaxPowerKw (float) –

  • C (float) –

  • ROff (float) –

  • ROn (float) –

  • RoomTempF (int) –

  • AnnualHvacKwhTh (int) –

  • BetaOt (int) –

  • TempUnit (RecognizedTemperatureUnit) –

  • AmbientPowerInKw (float) –

  • HouseWorstCaseTempF (int) –

  • TypeName (Literal['atn.params.brickstorageheater']) –

  • Version (str) –

GNodeAlias:

  • Description: GNode Alias

  • Format: LeftRightDot

HomeCity:

  • Description: Home City

TimezoneString:

  • Description: Timezone String

StorageSteps:

  • Description: Storage Steps. The number of nodes in each TimeSlice for the Dijkstra graph.

FloSlices:

  • Description: . The number of nodes for each storage level in the Dijstra graph.

SliceDurationMinutes:

  • Description: . The length of

CurrencyUnit:

  • Description:

Tariff:

  • Description:

EnergyType:

  • Description:

StandardOfferPriceDollarsPerMwh:

  • Description:

DistributionTariffDollarsPerMwh:

  • Description:

MaxBrickTempC:

  • Description:

RatedMaxPowerKw:

  • Description:

C:

  • Description:

ROff:

  • Description:

ROn:

  • Description:

RoomTempF:

  • Description:

AnnualHvacKwhTh:

  • Description:

BetaOt:

  • Description:

TempUnit:

  • Description:

AmbientPowerInKw:

  • Description:

HouseWorstCaseTempF:

  • Description:

class gwatn.types.atn_params_brickstorageheater.check_is_left_right_dot(v)

LeftRightDot format: Lowercase alphanumeric words separated by periods, most significant word (on the left) starting with an alphabet character.

Raises:

ValueError – if not LeftRightDot format

Parameters:

v (str) –

class gwatn.types.AtnParamsBrickstorageheater_Maker(g_node_alias, home_city, timezone_string, storage_steps, flo_slices, slice_duration_minutes, currency_unit, tariff, energy_type, standard_offer_price_dollars_per_mwh, distribution_tariff_dollars_per_mwh, max_brick_temp_c, rated_max_power_kw, c, r_off, r_on, room_temp_f, annual_hvac_kwh_th, beta_ot, temp_unit, ambient_power_in_kw, house_worst_case_temp_f)
Parameters:

  • g_node_alias (str) –

  • home_city (str) –

  • timezone_string (str) –

  • storage_steps (int) –

  • flo_slices (int) –

  • slice_duration_minutes (int) –

  • currency_unit (RecognizedCurrencyUnit) –

  • tariff (DistributionTariff) –

  • energy_type (EnergySupplyType) –

  • standard_offer_price_dollars_per_mwh (int) –

  • distribution_tariff_dollars_per_mwh (int) –

  • max_brick_temp_c (int) –

  • rated_max_power_kw (float) –

  • c (float) –

  • r_off (float) –

  • r_on (float) –

  • room_temp_f (int) –

  • annual_hvac_kwh_th (int) –

  • beta_ot (int) –

  • temp_unit (RecognizedTemperatureUnit) –

  • ambient_power_in_kw (float) –

  • house_worst_case_temp_f (int) –

classmethod tuple_to_type(tuple)

Given a Python class object, returns the serialized JSON type object

Parameters:

tuple (AtnParamsBrickstorageheater) –

Return type:

str

classmethod type_to_tuple(t)

Given a serialized JSON type object, returns the Python class object

Parameters:

t (str) –

Return type:

AtnParamsBrickstorageheater