Dados gerais (dadger.rvX)

As informações de entrada gerais do DECOMP, localizadas no arquivo geralmente denominado dadger.rvX, onde X varia de 0 a 4, são armazenadas na classe:

class Dadger(data=Ellipsis)[código-fonte]

Armazena os dados de entrada gerais do DECOMP.

Esta classe lida com as informações de entrada fornecidas ao DECOMP no dadger.rvx. Possui métodos para acessar individualmente cada registro, editá-lo e também cria alguns novos registros.

Obtém um registro que define modificações nos parâmetros das UHE em um Dadger.

Parâmetros:

codigo_usina (int) – código da UHE modificada
modificacao (subtipos do tipo AC) – classe da modificação realizada
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

AC | list[AC] | pandas.DataFrame | None

Obtém um registro que define as curvas de déficit no estudo descrito pelo Dadger.

Parâmetros:

codigo_curva (int | None) – Índice da curva de déficit descrita
codigo_submercado (int | None) – submercado para o qual valerá a curva.
nome_curva (str | None) – nome da curva.
estagio (int | None) – estagio para o qual valerá a curva.
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

LU | list[LU] | pandas.DataFrame | None

Obtém um registro que cadastra os coeficientes das restrições de energia armazenada.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro
codigo_ree (int | None) – REE do coeficiente
coeficiente (float | None) – valor do coeficiente para a energia
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

CM | list[CM] | pandas.DataFrame | None

Obtém um registro que cadastra os coeficientes das restrições de vazão.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro
estagio (int | None) – o estágio do coeficiente
codigo_usina (int | None) – o código da UHE para a restrição
coeficiente (float | None) – valor do coeficiente para a usina na restrição
tipo (str | None) – o mnemônico de tipo da restrição
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

CQ | list[CQ] | pandas.DataFrame | None

property cs: CS | None

Obtém o (único) registro que habilita a: consistência de dados.

Retorna:: Um registro, se existir.
Tipo de retorno:: CS | None.

Obtém um registro que define uma usina termelétrica existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_usina (int | None) – código que especifica o registro da UTE
estagio (int | None) – estágio associado ao registro
codigo_submercado (str | None) – submercado da UTE
nome_usina (str | None) – nome da UTE
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

CT | list[CT] | pandas.DataFrame | None

Obtém um registro que cadastra os coeficientes das restrições de volume.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro
estagio (int | None) – o estágio do coeficiente
codigo_usina (int | None) – o código da UHE para a restrição
coeficiente (float | None) – valor do coeficiente para a usina na restrição
tipo (str | None) – o mnemônico de tipo da restrição
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

CV | list[CV] | pandas.DataFrame | None

Obtém um registro que altera as tolerâncias do solver.

Parâmetros:

codigo_newave (int | None) – código da usina no NEWAVE
codigo_decomp (int | None) – código da usina no DECOMP
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

CX | list[CX] | pandas.DataFrame | None

Obtém um registro que especifica as retiradas de água para outros usos (desvios de água) por usina (UHE) existente no estudo especificado no Dadger

Parâmetros:

codigo_usina_retirada (int | None) – Código da UHE a montante da qual será feita a retirada
codigo_usina_retorno (int | None) – Código da UHE a montante da qual se derá o retorno.
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

DA | list[DA] | pandas.DataFrame | None

Obtém um registro que define as durações dos patamares no estudo descrito pelo Dadger.

Parâmetros:

estagio (int | None) – estágio sobre o qual serão definidas as durações dos patamares
codigo_submercado (int | None) – submercado para o qual valerão os patamares.
numero_patamares (int | None) – número de patamares
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

DP | list[DP] | pandas.DataFrame | None

property dt: DT | None

Obtém o (único) registro que define a data de referência do estudo definido no Dadger

Retorna:: Um registro, se existir.
Tipo de retorno:: DT | None.

ea(codigo_ree: int | None = None, df: bool = False) → EA | List[EA] | DataFrame | None[código-fonte]

Obtém um registro que especifica a ENA dos meses anteriores ao estudo.

Parâmetros:

codigo_ree (int | None) – Código do REE
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

EA | list[EA] | pandas.DataFrame | None

Obtém um registro que especifica a ENA das semanas anteriores ao estudo.

Parâmetros:

codigo_ree (int | None) – Código do REE
numero_semanas (int | None) – Número de semanas do mês anterior
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

ES | list[ES] | pandas.DataFrame | None

property ev: EV | None

Obtém o (único) registro que define a evaporação Dadger

Retorna:: Um registro, se existir.
Tipo de retorno:: EV | None.

property fa: FA | None

Obtém o (único) registro que define o arquivo de índices.

Retorna:: Um registro, se existir.
Tipo de retorno:: FA | None.

Obtém um registro que especifica os caminhos para os arquivos com a FCF do NEWAVE.

Parâmetros:

tipo (str | None) – Mnemônico do tipo de FCF especificado no registro
caminho (str | None) – caminho para o arquivo com a FCF
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

FC | list[FC] | pandas.DataFrame | None

Obtém um registro que especifica os fatores de disponibilidade por UHE existente no estudo especificado no Dadger

Parâmetros:

codigo_usina (int | None) – Código da UHE associada ao registro
frequencia (int | None) – Frequência da UHE, quando for Itaipu
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

FD | list[FD] | pandas.DataFrame | None

Obtém um registro que cadastra os coeficientes das restrições elétricas.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro
estagio (int | None) – o estágio do coeficiente
codigo_submercado_de (int | None) – o código do submercado DE
codigo_submercado_para (int | None) – o código do submercado PARA
coeficiente (float | None) – valor do coeficiente para a interligação na restrição
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FI | list[FI] | pandas.DataFrame | None

property fj: FJ | None

Obtém o (único) registro que define o arquivo polinjus Dadger

Retorna:: Um registro, se existir.
Tipo de retorno:: FJ | None.

Obtém um registro que especifica as taxas de irrigação por posto (UHE) existente no estudo especificado no Dadger

Parâmetros:

codigo_usina (int | None) – Código da UHE associada ao registro
estagio (int | None) – Estágio de definição da FP da UHE
tipo_entrada_janela_turbinamento (int | None) – unidade de entrada dos valores da janela de turbinamento
numero_pontos_turbinamento (int | None) – número de pontos para discretização da janela
limite_inferior_janela_turbinamento (float | None) – limite inferior da janela
limite_superior_janela_turbinamento (float | None) – limite superior da janela
tipo_entrada_janela_volume (int | None) – unidade de entrada dos valores da janela de volume
numero_pontos_volume (int | None) – número de pontos para discretização da janela
limite_inferior_janela_volume (float | None) – limite inferior da janela
limite_superior_janela_volume (float | None) – limite superior da janela
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

FP | list[FP] | pandas.DataFrame | None

Obtém um registro que cadastra os coeficientes das restrições elétricas.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro
estagio (int | None) – o estágio do coeficiente
codigo_usina (int | None) – o código da UTE para a restrição
coeficiente (float | None) – valor do coeficiente para a usina na restrição
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FT | list[FT] | pandas.DataFrame | None

Obtém um registro que cadastra os coeficientes das restrições elétricas.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro
estagio (int | None) – o estágio do coeficiente
codigo_usina (int | None) – o código da UHE para a restrição
coeficiente (float | None) – valor do coeficiente para a usina na restrição
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

FU | list[FU] | pandas.DataFrame | None

property gp: GP | None

Obtém o (único) registro que define o gap para convergência considerado no estudo definido no Dadger

Retorna:: Um registro, se existir.
Tipo de retorno:: GP | None.

Obtém um registro que cadastra uma restrição de energia armazenada existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro da restrição de energia armazenada
estagio (int | None) – estágio para o qual vale a restrição de energia armazenada
tipo_limite (int | None) – flag para o tipo de limite considerado
forma_calculo_produtibilidades (int | None) – flag para a forma do cálculo das probutibilidades
tipo_valores_produtibilidades (int | None) – flag para o tipo de valores das probutibilidades
tipo_penalidade (int | None) – flag para o tipo de penalidade aplicada
valor_penalidade (float | None) – valor de penalidade aplicada
arquivo_produtibilidades (int | None) – nome do arquivo com as produtibilidades das usinas
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se houverem.

Tipo de retorno:

HE | list[HE] | pandas.DataFrame | None

Obtém um registro que cadastra uma restrição de vazão existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro da restrição de vazão
estagio_inicial (int | None) – estágio inicial da restrição de vazão
estagio_final (int | None) – estágio final da restrição de vazão
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

HQ | list[HQ] | pandas.DataFrame | None

Obtém um registro que cadastra uma restrição de volume mínimo armazenado existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro da restrição de volume
estagio_inicial (int | None) – estágio inicial da restrição de volume
estagio_final (int | None) – estágio final da restrição de volume
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

HV | list[HV] | pandas.DataFrame | None

Obtém um registro que define os limites de intercâmbio no estudo descrito pelo Dadger.

Parâmetros:

estagio (int | None) – estágio sobre o qual serão definidas as gerações
nome_submercado_de (int | None) – submercado de origem
nome_submercado_para (int | None) – submercado de destino
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

IA | list[IA] | pandas.DataFrame | None

ir(tipo: str | None = None, df: bool = False) → IR | List[IR] | DataFrame | None[código-fonte]

Obtém um registro que especifica os relatórios de saída a serem produzidos pelo DECOMP após a execução do estudo descrito no Dadger.

Parâmetros:

tipo (str | None) – Mnemônico do tipo de relatório especificado no registro
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

IR | list[IR] | pandas.DataFrame | None

Obtém um registro que especifica os limites inferiores e superiores por patamar de uma restrição de vazão existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_restricao (int | None) – Índice do código que especifica o registro da restrição de vazão
estagio (int | None) – Estágio sobre o qual valerão os limites da restrição de vazão
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

LQ | list[LQ] | pandas.DataFrame | None

Exemplos

Para um objeto Dadger que possua uma restrição HQ de código 1, definida para os estágios de 1 a 5, com limites LQ definidos apenas para o estágio 1, estes podem ser acessados com:

>>> lq = dadger.lq(1, 1)
>>> lq
    <idecomp.decomp.modelos.dadger.LQ object at 0x0000026E5C269550>

Se for acessado o registro LQ de um estágio fora dos limites da restrição HQ, isso resultará em um erro:

>>> dadger.lq(1, 7)
    Traceback (most recent call last):
    ...
    ValueError: Estágio 7 fora dos limites do registro HQ

Por outro lado, se for acessado o registro LQ em um estágio dentro dos limites do registro HQ, porém sem limites próprios definidos, será criado um registro idêntico ao do último estágio existente, e este será retornado:

>>> lq2 = dadger.lq(1, 5)
>>> lq.limites_inferiores == lq2.limites_inferiores
    True

Obtém um registro que especifica os limites inferiores e superiores por patamar de uma restrição elétrica existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_restricao (int | None) – Índice do código que especifica o registro da restrição elétrica
estagio (int | None) – Estágio sobre o qual valerão os limites da restrição elétricas
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

LU | list[LU] | pandas.DataFrame | None

Exemplos

Para um objeto Dadger que possua uma restrição RE de código 1, definida para os estágios de 1 a 5, com limites LU definidos apenas para o estágio 1, estes podem ser acessados com:

>>> lu = dadger.lu(1, 1)
>>> lu
    <idecomp.decomp.modelos.dadger.LU object at 0x0000026E5C269550>

Se for acessado o registro LU de um estágio fora dos limites da restrição RE, isso resultará em um erro:

>>> dadger.lu(1, 7)
    Traceback (most recent call last):
    ...
    ValueError: Estágio 7 fora dos limites do registro RE

Por outro lado, se for acessado o registro LU em um estágio dentro dos limites do registro RE, porém sem limites próprios definidos, será criado um registro idêntico ao do último estágio existente, e este será retornado:

>>> lu2 = dadger.lu(1, 5)
>>> lu.limites_inferiores == lu2.limites_inferiores
    True

Obtém um registro que especifica os limites inferior e superior de uma restrição de volume mínimo existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_restricao (int | None) – Índice do código que especifica o registro da restrição de volume
estagio (int | None) – Estágio sobre o qual valerão os limites da restrição de volume
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

LV | list[LV] | pandas.DataFrame | None

Exemplos

Para um objeto Dadger que possua uma restrição HV de código 1, definida para os estágios de 1 a 5, com limites LV definidos apenas para o estágio 1, estes podem ser acessados com:

>>> lv = dadger.lv(1, 1)
>>> lv
    <idecomp.decomp.modelos.dadger.LV object at 0x0000026E5C269550>

Se for acessado o registro LV de um estágio fora dos limites da restrição HV, isso resultará em um erro:

>>> dadger.lv(1, 7)
    Traceback (most recent call last):
    ...
    ValueError: Estágio 7 fora dos limites do registro HV

Por outro lado, se for acessado o registro LV em um estágio dentro dos limites do registro HV, porém sem limites próprios definidos, será criado um registro idêntico ao do último estágio existente, e este será retornado:

>>> lv2 = dadger.lv(1, 5)
>>> lv.limite_inferior == lv2.limite_inferior
    True

Obtém um registro que especifica as manutenções programadas por UHE existente no estudo especificado no Dadger

Parâmetros:

codigo_usina (int | None) – Código da UHE associada ao registro
frequencia (int | None) – Frequência da UHE, quando for Itaipu
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

MP | list[MP] | pandas.DataFrame | None

Obtém um registro que especifica as manutenções programadas por UTE existente no estudo especificado no Dadger

Parâmetros:

codigo_usina (int | None) – Código da UTE associada ao registro
codigo_submercado (int | None) – Código do submercado da UTE
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

MT | list[MT] | pandas.DataFrame | None

property ni: NI | None

Obtém o (único) registro que define o número máximo de iterações do DECOMP no estudo definido no Dadger

Retorna:: Um registro, se existir.
Tipo de retorno:: NI | None.

pd(algoritmo: str | None = None) → PD | List[PD] | None[código-fonte]

Obtém um registro que especifica o algoritmo usado para a solução.

Parâmetros:: algoritmo (str | None) – Mnemônico do algoritmo
Retorna:: Um ou mais registros, se existirem.
Tipo de retorno:: PD | list[PD] | None

Obtém um registro que altera penalidades de vertimento,: intercâmbio e desvios.

Parâmetros:

codigo_submercado (int | None) – Índice do submercado
tipo (int | None) – tipo de restrição a ser modificada
penalidade (float | None) – valor da penalidade
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

PE | list[PE] | pandas.DataFrame | None

Obtém um registro que define as gerações das pequenas usinas no estudo descrito pelo Dadger.

Parâmetros:

nome – o nome das gerações
codigo_submercado (int | None) – submercado para o qual valerão as gerações
estagio (int | None) – estágio sobre o qual serão definidas as gerações
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

PQ | list[PQ] | pandas.DataFrame | None

property pu: PU | None

Obtém o (único) registro que define se será usado PL único.

Retorna:: Um registro, se existir.
Tipo de retorno:: PU | None.

Obtém um registro que altera as penalidades das variáveis: de folga.

Parâmetros:

penalidade_variaveis_folga (float | None) – valor da nova penalidade das variáveis de folga
tolerancia_viabilidade_restricoes (float | None) – valor da tolerância para a viabilidade das restrições
iteracoes_atualizacao_penalidade (int | None) – número de iterações para a atualização da penalidade variável
fator_multiplicacao_folga (float | None) – o fator para multiplicação da folga
valor_inicial_variaveis_folga (float | None) – o valor inicial para as variáveis de folga
valor_final_variaveis_folga (float | None) – o valor final para as variáveis de folga

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

PV | list[PV] | None

qi(codigo_usina: int | None = None, df: bool = False) → QI | List[QI] | DataFrame | None[código-fonte]

Obtém um registro que especifica o tempo de viagem para cálculo da ENA.

Parâmetros:

codigo_usina (int | None) – Código da UHE
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

QI | list[QI] | pandas.DataFrame | None

property rc: RC | None

Obtém o (único) registro que insere restrições do tipo escada.

Retorna:: Um registro, se existir.
Tipo de retorno:: RC | None.

Obtém um registro que cadastra uma restrição elétrica existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_restricao (int | None) – código que especifica o registro da restrição elétrica
estagio_inicial (int | None) – estágio inicial da restrição elétrica
estagio_final (int | None) – estágio final da restrição elétrica
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

RE | list[RE] | pandas.DataFrame | None

rq(codigo_ree: int | None = None, df: bool = False) → RQ | List[RQ] | DataFrame | None[código-fonte]

Obtém um registro que especifica as vazões mínimas históricas por REE existentes no estudo especificado no Dadger

Parâmetros:

codigo_ree (int | None) – Código do REE
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

RQ | list[RQ] | pandas.DataFrame | None

rt(restricao: str | None = None, df: bool = False) → RT | List[RT] | DataFrame | None[código-fonte]

Obtém um registro que especifica uma retirada de restrição de soleira de vertedouro ou canal de desvio.

Parâmetros:

restricao (str | None) – Mnemônico da restrição retirada (CRISTA ou DESVIO)
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

RT | list[RT] | pandas.DataFrame | None

Obtém um registro que define os submercados existentes no estudo descrito pelo Dadger.

Parâmetros:

codigo_submercado (int | None) – código que especifica o registro do submercado
nome_submercado (str | None) – nome do submercado

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

SB | list[SB] | pandas.DataFrame | None

property te: TE | None

Obtém o (único) registro que define o nome do estudo no Dadger

Retorna:: Um registro, se existir.
Tipo de retorno:: TE | None.

ti(codigo_usina: int | None = None, df: bool = False) → TI | List[TI] | DataFrame | None[código-fonte]

Obtém um registro que especifica as taxas de irrigação por posto (UHE) existente no estudo especificado no Dadger

Parâmetros:

codigo_usina (int | None) – Código da UHE associada ao registro
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

TI | list[TI] | pandas.DataFrame | None

Obtém um registro que altera as tolerâncias do solver.

Parâmetros:

tolerancia_primaria (float | None) – valor da tolerância primária do solver.
tolerancia_secundaria (float | None) – valor da tolerância secundária do solver.
zera_coeficientes (int | None) – funcionalidade de zerar os coeficientes de cortes não ótimos.
tolerancia_teste_otimalidade (float | None) – valor da tolerância usada no teste de otimalidade.

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

TS | list[TS] | None

property tx: TX | None

Obtém o (único) registro que define a taxa de desconto aplicada no estudo definido no Dadger

Retorna:: Um registro, se existir.
Tipo de retorno:: TX | None.

Obtém um registro que define uma usina elevatória existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_usina (int | None) – índice do código que especifica o registro da UHE
codigo_submercado (int | None) – índice do submercado da UHE
nome_usina (int | None) – nome da UHE
codigo_usina_montante (int | None) – código da UHE a montante
codigo_usina_jusante (int | None) – código da UHE a jusante
evaporacao (int | None) – consideração da evaporação na UHE
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

UE | list[UE] | pandas.DataFrame | None

Obtém um registro que define uma usina hidrelétrica existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_usina (int | None) – índice do código que especifica o registro da UHE
codigo_ree (int | None) – índice do ree da UHE
volume_inicial (float | None) – volume inicial da UHE
evaporacao (int | None) – consideração da evaporação na UHE
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

UH | list[UH] | pandas.DataFrame | None

Obtém um registro que define um posto que tem influencia sobre a vazão de jusante da primeira existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_usina_influenciada (int | None) – código da UHE influenciada
codigo_posto_influenciador (int | None) – código do posto influenciador
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VA | list[VA] | pandas.DataFrame | None

ve(codigo_usina: int | None = None, df: bool = False) → VE | List[VE] | DataFrame | None[código-fonte]

Obtém um registro que especifica os volumes de espera por posto (UHE) existente no estudo especificado no Dadger

Parâmetros:

codigo_usina (int | None) – Código da UHE associada
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VE | list[VE] | pandas.DataFrame | None

Obtém um registro que especifica os tempos de viagem da água em uma UHE existente no no estudo descrito pelo Dadger.

Parâmetros:

codigo_usina (int | None) – Índice da UHE associada aos tempos de viagem
duracao (int | None) – duração, em horas, da viagem da água
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VI | list[VI] | pandas.DataFrame | None

vl(codigo_usina_influenciada: int | None = None, df: bool = False) → VL | List[VL] | DataFrame | None[código-fonte]

Obtém um registro que define uma usina hidrelétrica que sofre influência de vazão lateral na cota de jusante existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_usina_influenciada (int | None) – código da UHE influenciada
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VL | list[VL] | pandas.DataFrame | None

property vt: VT | None

Obtém o (único) registro que define o arquivo com: cenários de vento.

Retorna:: Um registro, se existir.
Tipo de retorno:: VT | None.

Obtém um registro que define uma usina hidrelétrica que tem influencia sobre a vazão de jusante da primeira existente no estudo descrito pelo Dadger.

Parâmetros:

codigo_usina_influenciada (int | None) – código da UHE influenciada
codigo_usina_influenciadora (int | None) – código da UHE influenciadora
df (bool) – ignorar os filtros e retornar todos os dados de registros como um DataFrame

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VU | list[VU] | pandas.DataFrame | None

As informações existentes em cada um dos registros são armazenadas em modelos próprios para cada um. Os registros suportados até o momento são os utilizados nos estudos oficiais de operação:

class TE(previous=None, next=None, data=None)[código-fonte]

Registro que contém a usina modificada.

property titulo: str | None

O único conteúdo do registro (título do estudo).

Retorna:: O título do estudo
Tipo de retorno:: str | None

class SB(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro dos submercados.

property codigo_submercado: int | None

O código de cadastro do submercado.

Retorna:: O código.
Tipo de retorno:: int | None]

property nome_submercado: str | None

O nome de cadastro do submercado.

Retorna:: O nome.
Tipo de retorno:: str | None

class UH(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro das UHEs, com os seus volumes iniciais no estudo.

property balanco_hidrico_patamar: int | None

Consideração do balanço hídrico por patamar.

Retorna:: A consideração, ou não.
Tipo de retorno:: int | None

property codigo_ree: int | None

O REE de cadastro da UHE.

Retorna:: O REE.
Tipo de retorno:: int | None

property codigo_usina: int | None

O código de cadastro da UHE.

Retorna:: O código.
Tipo de retorno:: int | None

property configuracao_newave: str | None

Sinaliza a existência da usina na configuração do NEWAVE, para compatibilização.

Retorna:: A existência da usina na configuração.
Tipo de retorno:: str | None

property estagio_inicio_producao: int | None

Estágio a partir da qual a usina começa a produzir energia.

Retorna:: O índice do estágio.
Tipo de retorno:: int | None

property evaporacao: int | None

A consideração ou não de evaporação para a UHE.

Retorna:: A consideração.
Tipo de retorno:: int | None

property limite_superior_vertimento: float | None

O limite superior para vertimento da usina.

Retorna:: O limite em m3/s.
Tipo de retorno:: float | None

property vazao_defluente_minima: float | None

O vazão defluente mínima da usina em m3/s.

Retorna:: A vazão em m3/s.
Tipo de retorno:: float | None

property volume_inicial: float | None

O volume inicial da UHE para o estudo.

Retorna:: O volume.
Tipo de retorno:: float | None

property volume_morto_inicial: float | None

Volume morto inicial da usina.

Retorna:: O volume em hm3.
Tipo de retorno:: float | None

class CT(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro das usinas termelétricas com os seus custos e capacidades.

property codigo_submercado: int | None

O submercado de cadastro da UTE.

Retorna:: O submercado.
Tipo de retorno:: int | None

property codigo_usina: int | None

O código de cadastro da UTE.

Retorna:: O código.
Tipo de retorno:: int | None

property cvu: List[float] | None

O CVU da UTE por patamar.

Retorna:: O CVU.
Tipo de retorno:: list[float] | None

property disponibilidade: List[float] | None

A disponibilidade da UTE por patamar.

Retorna:: A disponibilidade.
Tipo de retorno:: list[float] | None

property estagio: str | None

O estágio associado às propriedades cadastradas.

Retorna:: O estágio.
Tipo de retorno:: int | None

property inflexibilidade: List[float] | None

A inflexibilidade da UTE por patamar.

Retorna:: A inflexibilidade.
Tipo de retorno:: list[float] | None

property nome_usina: str | None

O nome de cadastro da UTE.

Retorna:: O nome como uma str.
Tipo de retorno:: str | None

class UE(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro das estações de bombeamento (usinas elevatórias).

property codigo_submercado: int | None

O submercado de cadastro da UE, conforme registro SB.

Retorna:: O submercado.
Tipo de retorno:: int | None

property codigo_usina: int | None

O código de cadastro da UE.

Retorna:: O código.
Tipo de retorno:: int | None

property codigo_usina_jusante: int | None

O código da UHE a jusante, conforme registro UH.

Retorna:: O código.
Tipo de retorno:: int | None

property codigo_usina_montante: int | None

O código da UHE a montante, conforme registro UH.

Retorna:: O código.
Tipo de retorno:: int | None

property nome_usina: str | None

O nome da estação de bombeamento.

Retorna:: O nome.
Tipo de retorno:: str | None

property taxa_consumo: float | None

A taxa de consumo.

Retorna:: A taxa em MWmed/m3/s.
Tipo de retorno:: float | None

property vazao_maxima_bombeavel: float | None

A vazão mínima bombeável.

Retorna:: A vazão em m3/s
Tipo de retorno:: float | None

property vazao_minima_bombeavel: float | None

A vazão mínima bombeável.

Retorna:: A vazão em m3/s
Tipo de retorno:: float | None

class DP(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro das durações dos patamares.

property carga: List[float] | None

A carga em Mwmed pata cada patamar de carga

Retorna:: A carga.
Tipo de retorno:: list[float] | None

property codigo_submercado: int | None

O submercado associado às durações especificadas.

Retorna:: O submercado.
Tipo de retorno:: int | None

property duracao: List[float] | None

A duração de cada patamar de carga em horas

Retorna:: A duração em horas.
Tipo de retorno:: list[float] | None

property estagio: int | None

O estágio associado às durações especificadas.

Retorna:: O estágio.
Tipo de retorno:: int | None

property numero_patamares: int | None

O número de patamares.

Retorna:: O número de patamares.
Tipo de retorno:: int | None

class PQ(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro da geração por pequenas usinas.

property codigo_submercado: int | None

O submercado associado à geração.

Retorna:: O submercado.
Tipo de retorno:: int | None

property estagio: int | None

O estágio associado à geração.

Retorna:: O estágio.
Tipo de retorno:: int | None

property geracao: List[float] | None

A geração em Mwmed para cada patamar de carga.

Retorna:: A geração.
Tipo de retorno:: list[float] | None

property nome: str | None

O nome da geração.

Retorna:: O nome.
Tipo de retorno:: str | None

class CD(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro dos custos de déficit.

property codigo_curva: int | None

O código da curva de déficit.

Retorna:: O código da curva.
Tipo de retorno:: int | None

property codigo_submercado: int | None

O código do submercado associado.

Retorna:: O submercado.
Tipo de retorno:: int | None

property custo: List[float] | None

O custo de déficit.

Retorna:: O custo.
Tipo de retorno:: list[float] | None

property estagio: int | None

O estágio de vigência do custo de déficit

Retorna:: O estágio.
Tipo de retorno:: int | None

property limite_superior: List[float] | None

O limite superior para consideração dos custos.

Retorna:: Os limites.
Tipo de retorno:: list[float] | None

property nome_curva: str | None

O nome da curva de déficit

Retorna:: O nome.
Tipo de retorno:: str | None

class RI(previous=None, next=None, data=None)[código-fonte]: Registro que contém as restrições de Itaipu.

class IA(previous=None, next=None, data=None)[código-fonte]

Registro que contém os limites de intercâmbio entre os subsistemas.

property estagio: int | None

O índice do estágio.

Retorna:: O estágio.
Tipo de retorno:: int | None

property nome_submercado_de: str | None

O nome do submercado de origem.

Retorna:: O submercado.
Tipo de retorno:: str | None

property nome_submercado_para: str | None

O nome do submercado de destino.

Retorna:: O submercado.
Tipo de retorno:: str | None

class TX(previous=None, next=None, data=None)[código-fonte]

Registro que contém a taxa de desconto anual do modelo.

property taxa: float | None

A taxa de desconto em % utilizada no estudo.

Retorna:: A taxa.
Tipo de retorno:: float | None

class GP(previous=None, next=None, data=None)[código-fonte]

Registro que contém o gap de tolerância para convergência.

property gap: float | None

O gap considerado para convergência no estudo

Retorna:: O gap.
Tipo de retorno:: float | None

class NI(previous=None, next=None, data=None)[código-fonte]

Registro que contém o número máximo de iterações do modelo.

property iteracoes: int | None

O número máximo de iterações do modelo no estudo

Retorna:: O número de iterações.
Tipo de retorno:: int | None

property tipo_limite: int | None

Se o número de interações fornecido é mínimo ou máximo.

Retorna:: O tipo de limite de iterações
Tipo de retorno:: int | None

class DT(previous=None, next=None, data=None)[código-fonte]

Registro que contém a data de referência do estudo.

property ano: int | None

O ano de referência para realização do estudo

Retorna:: O ano
Tipo de retorno:: int | None

property dia: int | None

O dia de referência para realização do estudo

Retorna:: O dia
Tipo de retorno:: int | None

property mes: int | None

O mês de referência para realização do estudo

Retorna:: O mês
Tipo de retorno:: int | None

class MP(previous=None, next=None, data=None)[código-fonte]

Registro que contém as manutenções programadas das UHEs.

property codigo_usina: int | None

O código da UHE associada às manutenções programadas.

Retorna:: O código como int.

property frequencia: int | None

A frequência quando se trata da UHE Itaipu.

Retorna:: A frequência como int.

property manutencao: List[float] | None

Os fatores de manutenção programada por estágio do estudo. A posição na lista indica a qual estágio ele está associada [e1, e2, e3, …].

Retorna:: As manutenções.
Type:: list[float] | None

class MT(previous=None, next=None, data=None)[código-fonte]

Registro que contém as manutenções programadas das UTEs.

property codigo_submercado: int | None

O código do submercado ao qual a UTE pertence.

Retorna:: O código como int.

property codigo_usina: int | None

O código da UTE associada às manutenções programadas.

Retorna:: O código como int.

property manutencao: List[float] | None

Os fatores de manutenção programada por estágio do estudo. A posição na lista indica a qual estágio ele está associada [e1, e2, e3, …].

Retorna:: As manutenções.
Type:: list[float] | None

class FD(previous=None, next=None, data=None)[código-fonte]

Registro que contém os fatores de disponibilidade das UHEs.

property codigo_usina: int | None

O código da UHE associada aos fatores de disponibilidade.

Retorna:: O código como int.

property fator: List[float] | None

Os fatores de disponibilidade por estágio do estudo. A posição na lista indica a qual estágio ele está associada [e1, e2, e3, …].

Retorna:: Os fatores.
Type:: list[float] | None

property frequencia: int | None

A frequência quando se trata da UHE Itaipu.

Retorna:: A frequência como int.

class VE(previous=None, next=None, data=None)[código-fonte]

Registro que contém os volumes de espera das UHEs.

property codigo_usina: int | None

O código da usina associada ao volume.

Retorna:: O código.
Tipo de retorno:: int | None

property volume: List[float] | None

O volume de espera por estagio.

Retorna:: O volume.
Tipo de retorno:: list[float] | None

class RE(previous=None, next=None, data=None)[código-fonte]

Registro que contém os cadastros de restrições elétricas.

property codigo_restricao: int | None

O código de cadastro para a restrição

Retorna:: O código.
Tipo de retorno:: int | None

property estagio_final: int | None

O estágio final para consideração da restrição

Retorna:: O estágio.
Tipo de retorno:: int | None

property estagio_inicial: int | None

O estágio inicial para consideração da restrição

Retorna:: O estágio.
Tipo de retorno:: int | None

class LU(previous=None, next=None, data=None)[código-fonte]

Registro que contém os cadastros de limites das restrições elétricas.

property codigo_restricao: int | None

O código da restrição RE associada aos limites

Retorna:: O código.
Tipo de retorno:: int | None

property estagio: int | None

O estágio inicial para consideração dos limites, até que sejam especificados novos limites.

Retorna:: O estágio.
Tipo de retorno:: int | None

property limite_inferior: List[float] | None

O limite inferior por patamar para a restrição elétrica

Retorna:: O limite
Tipo de retorno:: list[float] | None

property limite_superior: List[float] | None

O limite superior por patamar para a restrição elétrica

Retorna:: O limite
Tipo de retorno:: list[float] | None

class FU(previous=None, next=None, data=None)[código-fonte]

Registro que contém os coeficientes das usinas hidráulicas nas restrições elétricas.

property codigo_restricao: int | None

O código da restrição elétrica, segundo registro RE.

Retorna:: O código como int.

property codigo_usina: int | None

O número da UHE conforme registro UH.

Retorna:: O número da UHE como int.

property coeficiente: float | None

O coeficiente de participação da usina na restrição.

Retorna:: O coeficiente como float

property estagio: int | None

O estágio associado.

Retorna:: O estágio como int.

property frequencia: int | None

A frequência para restrição elétrica, valendo 50 ou 60 para Itaipu e 0 para as demais.

Retorna:: O número da frequencia como int.

class FT(previous=None, next=None, data=None)[código-fonte]

Registro que contém os coeficientes das usinas térmicas nas restrições elétricas.

property codigo_restricao: int | None

O código da restrição elétrica, segundo registro RE.

Retorna:: O código como int.

property codigo_submercado: int | None

O código do submercado conforme registros CT ou TG.

Retorna:: O código do submercado como int.

property codigo_usina: int | None

O número da UTE conforme registro CT.

Retorna:: O número da UTE como int.

property coeficiente: float | None

O coeficiente de participação da usina na restrição.

Retorna:: O coeficiente como float

property estagio: int | None

O estágio associado.

Retorna:: O estágio como int.

class FI(previous=None, next=None, data=None)[código-fonte]

Registro que contém o sentido do fluxo da interligação entre os subsistemas associados à restrição elétrica.

property codigo_restricao: int | None

O código da restrição elétrica, segundo registro RE.

Retorna:: O código como int.

property codigo_submercado_de: str | None

O submercado de origem conforme registros SB.

Retorna:: O submercado como str.

property codigo_submercado_para: str | None

O submercado de destino conforme registros SB.

Retorna:: O submercado como str.

property coeficiente: float | None

O coeficiente de participação da interligação.

Retorna:: O coeficiente como float

property estagio: int | None

O estágio associado.

Retorna:: O estágio como int.

class VI(previous=None, next=None, data=None)[código-fonte]

Registro que contém os tempos de viagem da água entre usinas.

property codigo_usina: int | None

O código da UHE a partir do qual é contabilizado o tempo de viagem.

Retorna:: O código
Tipo de retorno:: int | None

property duracao: int | None

A duração da viagem da água (em horas) entre a UHE do código informado e sua usina à jusante segundo o hidr.

Retorna:: A duração
Tipo de retorno:: int | None

property vazao: List[float] | None

As vazões defluentes das semanas passadas para a usina do código informado. A posição da vazão na lista indica a qual semana passada se refere [s-1, s-2, s-3, …].

Retorna:: As vazões
Tipo de retorno:: list[float] | None

class IR(previous=None, next=None, data=None)[código-fonte]

Registro que contém as configurações de geração de relatórios de saída.

property tipo: str | None

Mnemônico que contém o tipo de relatório de saída escolhido.

Retorna:: O mnemônico.
Tipo de retorno:: str | None

class CI(previous=None, next=None, data=None)[código-fonte]: Registro que define contratos de importação de energia.

class CE(previous=None, next=None, data=None)[código-fonte]: Registro que define contratos de exportação de energia.

class FC(previous=None, next=None, data=None)[código-fonte]

Registro que contém informações para acessar a FCF fornecida pelo NEWAVE.

property caminho: str | None

O caminho relativo ou completo para o arquivo da FCF.

Retorna:: O caminho.
Tipo de retorno:: str | None

property tipo: str | None

O tipo de arquivo da FCF na forma dos mnemônicos aceitos pelo DECOMP.

Retorna:: O mnemônico.
Tipo de retorno:: str | None

class EA(previous=None, next=None, data=None)[código-fonte]

Registro que a ENA dos meses que antecedem o estudo.

property codigo_ree: int | None

O código do REE

Retorna:: O código.
Tipo de retorno:: int | None

property ena: List[float] | None

A ENA passada para o REE.

Retorna:: O ena.
Tipo de retorno:: list[float] | None

class ES(previous=None, next=None, data=None)[código-fonte]

Registro que define a ENA das semanas que antecedem o estudo.

property codigo_ree: int | None

O código do REE

Retorna:: O código.
Tipo de retorno:: int | None

property ena: List[float] | None

A ENA passada para o REE.

Retorna:: O ena.
Tipo de retorno:: list[float] | None

property numero_semanas_mes_anterior: int | None

O número de semanas do mês anterior

Retorna:: O número de semanas.
Tipo de retorno:: int | None

class QI(previous=None, next=None, data=None)[código-fonte]

Registro que define o tempo de viagem para o cálculo da ENA.

property codigo_usina: int | None

O índice da UHE

Retorna:: O índice.
Tipo de retorno:: int | None

property vazao: List[float] | None

As vazões incrementais para cálculo da ENA.

Retorna:: As incrementais para cálculo da ENA.
Tipo de retorno:: list[float] | None

class RT(previous=None, next=None, data=None)[código-fonte]

Registro utilizado para retirada de restrições de soleira de vertedouro e de canais de desvio.

property restricao: str | None

O mnemônico da restrição removida.

Retorna:: O mnemônico
Tipo de retorno:: str | None

class TI(previous=None, next=None, data=None)[código-fonte]

Registro que contém as taxas de irrigação por UHE.

property codigo_usina: int | None

O código da UHE associada às taxas de irrigação

Retorna:: O código como int.

property taxa: List[float] | None

As taxas de irrigação por estágio do estudo. A posição da taxa na lista indica a qual estágio ela está associada [e1, e2, e3, …].

Retorna:: As taxas.
Type:: list[float] | None

class FP(previous=None, next=None, data=None)[código-fonte]

Registro que contém os cadastros de restrições de alteração na função de produção das usinas.

property codigo_usina: int | None

O código da UHE associada à restrição FP.

Retorna:: O código
Tipo de retorno:: int | None

property estagio: int | None

O estágio associado à restrição FP.

Retorna:: O estágio
Tipo de retorno:: int | None

property limite_inferior_janela_turbinamento: float | None

O limite inferior da janela de turbinamento.

Retorna:: O limite.
Tipo de retorno:: float | None

property limite_inferior_janela_volume: float | None

A redução aplicada ao volume útil da usina, para ser utilizado como limite inferior da janela de volume.

Retorna:: O limite.
Tipo de retorno:: float | None

property limite_superior_janela_turbinamento: float | None

O limite superior da janela de turbinamento.

Retorna:: O limite.
Tipo de retorno:: float | None

property limite_superior_janela_volume: float | None

O acréscimo aplicado ao volume útil da usina, para ser utilizado como limite superior da janela de volume.

Retorna:: O limite.
Tipo de retorno:: float | None

property numero_pontos_turbinamento: int | None

O número de pontos para discretização da janela de turbinamento. Máximo permitido de 1000 pontos.

Retorna:: O número de pontos
Tipo de retorno:: int | None

property numero_pontos_volume: int | None

O número de pontos para discretização da janela de volume. Máximo permitido de 1000 pontos.

Retorna:: O número de pontos.
Tipo de retorno:: int | None

property tipo_entrada_janela_turbinamento: int | None

O tipo de entrada da janela de turbinamento fornecido na restrição FP. 0 para limites em percentual da vazão turbinada máxima das usinas, 1 para limites em m3/s.

Retorna:: O tipo de entrada
Tipo de retorno:: int | None

property tipo_entrada_janela_volume: int | None

O tipo de entrada da janela de volume fornecido na restrição FP. 0 para limites em percentual do volume útil das usinas, 1 para limites em hm3.

Retorna:: O tipo de entrada.
Tipo de retorno:: int | None

class RQ(previous=None, next=None, data=None)[código-fonte]

Registro que contém os percentuais de vazão defluente mínima histórica para cada REE.

property codigo_ree: int | None

O código do REE associado às vazões mínimas.

Retorna:: O código.
Tipo de retorno:: int | None

property vazao: List[float] | None

As vazões defluentes mínimas (percentuais) para o REE, por estágio [e1, e2, e3, …].

Retorna:: A vazão.
Tipo de retorno:: list[float] | None

class EZ(previous=None, next=None, data=None)[código-fonte]

Registro que contém o percentual máximo do volume útil para acoplamento.

property codigo_usina: int | None

Código da UHE associada, conforme registro UH.

Retorna:: O código da UHE.
Tipo de retorno:: int | None

property volume: float | None

O volume útil considerado para cálculo.

Retorna:: O volume útil em % do volume máximo.
Tipo de retorno:: float | None

class HV(previous=None, next=None, data=None)[código-fonte]

Registro que contém os cadastros de restrições de volume armazenado.

property codigo_restricao: int | None

O código da restrição HV.

Retorna:: O código.
Tipo de retorno:: int | None

property estagio_final: int | None

O estágio final de consideração da restrição HV.

Retorna:: O estágio.
Tipo de retorno:: int | None

property estagio_inicial: int | None

O estágio inicial de consideração da restrição HV.

Retorna:: O estágio.
Tipo de retorno:: int | None

class LV(previous=None, next=None, data=None)[código-fonte]

Registro que contém os cadastros dos limites das restrições de volume armazenado.

property codigo_restricao: int | None

O código da restrição HV associada aos limites

Retorna:: O código.
Tipo de retorno:: int | None

property estagio: int | None

‘ O estágio de consideração dos limites.

Retorna:: O estágio.
Tipo de retorno:: int | None

property limite_inferior: float | None

O limite inferior para o armazenamento.

Retorna:: O limite.
Tipo de retorno:: float | None

property limite_superior: float | None

O limite superior para o armazenamento.

Retorna:: O limite.
Tipo de retorno:: float | None

class CV(previous=None, next=None, data=None)[código-fonte]

Registro que contém os coeficientes das usinas hidráulicas nas restrições de volume armazenado.

property codigo_restricao: int | None

O código da restrição de volume, segundo registro HV.

Retorna:: O código como int.

property codigo_usina: int | None

O número da UHE ou estação de bombeamento conforme registros UH ou UE.

Retorna:: O número da UHE como int.

property coeficiente: float | None

O coeficiente da variável na restrição.

Retorna:: O coeficiente como float

property estagio: int | None

O estágio associado.

Retorna:: O estágio como int.

property tipo: str | None

O mnemônico de tipo da restrição.

Retorna:: O tipo como str.

class HQ(previous=None, next=None, data=None)[código-fonte]

Registro que contém os cadastros de restrições de vazões.

property codigo_restricao: int | None

O código da restrição HQ.

Retorna:: O código.
Tipo de retorno:: int | None

property estagio_final: int | None

O estágio final de consideração da restrição HQ.

Retorna:: O estágio.
Tipo de retorno:: int | None

property estagio_inicial: int | None

O estágio inicial de consideração da restrição HQ.

Retorna:: O estágio.
Tipo de retorno:: int | None

class LQ(previous=None, next=None, data=None)[código-fonte]

Registro que contém os cadastros dos limites das restrições de vazão.

property codigo_restricao: int | None

O código da restrição HQ associada aos limites

Retorna:: O código.
Tipo de retorno:: int | None

property estagio: int | None

O estágio de consideração dos limites.

Retorna:: O estágio.
Tipo de retorno:: int | None

property limite_inferior: List[float] | None

O limite inferior por patamar para a vazão.

Retorna:: Os limites.
Tipo de retorno:: list[float] | None

property limite_superior: List[float] | None

O limite superior por patamar para a vazão.

Retorna:: Os limites.
Tipo de retorno:: list[float] | None

class CQ(previous=None, next=None, data=None)[código-fonte]

Registro que contém os coeficientes das usinas hidráulicas nas restrições de vazão.

property codigo_restricao: int | None

O código da restrição de vazão, segundo registro HQ.

Retorna:: O código como int.

property codigo_usina: int | None

O número da UHE conforme registro UH.

Retorna:: O número da UHE como int.

property coeficiente: float | None

O coeficiente da variável na restrição.

Retorna:: O coeficiente como float

property estagio: int | None

O estágio associado.

Retorna:: O estágio como int.

property tipo: str | None

O mnemônico de tipo da restrição.

Retorna:: O tipo como str.

class AR(previous=None, next=None, data=None)[código-fonte]

Registro que contém as configurações de aversão a risco.

property alfa: float | None

O valor de alfa utilizado no CVaR.

Retorna:: O valor de alfa
Tipo de retorno:: float | None

property estagio: int | None

O estágio inicial de aplicação do CVaR.

Retorna:: O índice do estágio inicial.
Tipo de retorno:: int | None

property lamb: float | None

O valor de lambda utilizado no CVaR.

Retorna:: O valor de lambda
Tipo de retorno:: float | None

class EV(previous=None, next=None, data=None)[código-fonte]

Registro que contém as configurações de consideração da evaporação.

property modelo: int | None

O modelo de evaporação considerado

Retorna:: O modelo.
Tipo de retorno:: int | None

property volume_referencia: str | None

O mnemônico para o volume considerado

Retorna:: O mnemônico.
Tipo de retorno:: str | None

class FJ(previous=None, next=None, data=None)[código-fonte]

Registro que contém o arquivo de polinômios de jusante.

property arquivo: str

O nome do arquivo.

Retorna:: O nome
Tipo de retorno:: str | None

class HE(previous=None, next=None, data=None)[código-fonte]

Registro que contém o cadastro de uma restrição de energia armazenada.

property arquivo_produtibilidades: str | None

O arquivo com as definições das produtibilidades usadas para o cálculo da restrição RHE.

Retorna:: O arquivo externo com as produbitibilidades.
Tipo de retorno:: str | None

property codigo_restricao: int | None

O código de cadastro da restrição HE

Retorna:: O código.
Tipo de retorno:: int | None

property estagio: int | None

O estágio para consideração da restrição.

Retorna:: O estágio.
Tipo de retorno:: int | None

property forma_calculo_produtibilidades: int | None

Flag para indicar a forma de cálculo das produtividades das usinas usadas nas restrição.

Retorna:: A flag.
Tipo de retorno:: int | None

property limite: float | None

O limite para a energia armazenada associada ao registro HE.

Retorna:: O limite.
Tipo de retorno:: float | None

property tipo_limite: int | None

O tipo de limite especificado na restrição HE, em valor absoluto ou percentual.

Retorna:: O tipo.
Tipo de retorno:: int | None

property tipo_penalidade: int | None

O tipo de penalidade a ser considerada ao violar a restrição (inviabilidade ou penalização).

Retorna:: O tipo.
Tipo de retorno:: int | None

property tipo_valores_produtibilidades: int | None

Flag para indicar o tipo dos valores das produtividades das usinas usadas nas restrição.

Retorna:: O tipo.
Tipo de retorno:: int | None

property valor_penalidade: float | None

O valor da penalidade para a violação da restrição.

Retorna:: O valor.
Tipo de retorno:: float | None

class CM(previous=None, next=None, data=None)[código-fonte]

Registro que contém os coeficientes de uma restrição RHE.

property codigo_ree: int

O REE do coeficiente

Retorna:: O REE.
Tipo de retorno:: int | None

property codigo_restricao: int

O código de cadastro da restrição CM

Retorna:: O código.
Tipo de retorno:: int | None

property coeficiente: float

O coeficiente de energia considerado

Retorna:: O coeficiente.
Tipo de retorno:: float | None

class PD(previous=None, next=None, data=None)[código-fonte]

Registro que contém a escolha do algoritmo para resolução do PL.

property algoritmo: str | None

O algoritmo considerado.

Retorna:: O identificador do algoritmo.
Tipo de retorno:: str | None

class PU(previous=None, next=None, data=None)[código-fonte]

Registro que habilita a solução do problema via PL único.

property pl: int | None

O tipo de pl considerado.

Retorna:: O identificador do pl.
Tipo de retorno:: int | None

class RC(previous=None, next=None, data=None)[código-fonte]

Registro que inclui restrições do tipo escada.

property mnemonico: str | None

O tipo de mnemonico considerado.

Retorna:: O identificador do mnemonico.
Tipo de retorno:: str | None

class PE(previous=None, next=None, data=None)[código-fonte]

Registro que altera as penalidades de vertimento, intercâmbio e desvios.

property codigo_submercado: int | None

O código do submercado considerado

Retorna:: O código do submercado.
Tipo de retorno:: int | None

property penalidade: float | None

O novo valor de penalidade

Retorna:: O valor da penalidade
Tipo de retorno:: float | None

property tipo: int | None

O tipo de penalidade a ser modificado

Retorna:: O indice do tipo de penalidade
Tipo de retorno:: int | None

class TS(previous=None, next=None, data=None)[código-fonte]

Registro que altera as tolerâncias do solver.

property tolerancia_primaria: float | None

A nova tolerância primária do solver.

Retorna:: A tolerância
Tipo de retorno:: float | None

property tolerancia_secundaria: float | None

A nova tolerância secundária do solver.

Retorna:: A tolerância
Tipo de retorno:: float | None

property tolerancia_teste_otimalidade: float | None

A nova tolerância usada no teste de otimalidade da solução do PL.

Retorna:: A tolerância
Tipo de retorno:: float | None

property zera_coeficientes: int | None

Habilita ou não a funcionalidade de zerar coeficientes em casos de cortes não ótimos.

Retorna:: O valor do flag
Tipo de retorno:: int | None

class PV(previous=None, next=None, data=None)[código-fonte]

Registro que altera as penalidades das variáveis de folga do problema e as tolerâncias para a viabilidade das restrições.

property fator_multiplicacao_folga: float | None

O fator para multiplicação da folga ao longo das restrições.

Retorna:: A tolerância
Tipo de retorno:: float | None

property iteracoes_atualizacao_penalidade: int | None

O número de iterações para atualização da penalidade variável iterativa para as folgas.

Retorna:: O número de iterações
Tipo de retorno:: int | None

property penalidade_variaveis_folga: float | None

A nova penalidade para as variáveis de folga (R$/MWh).

Retorna:: A tolerância
Tipo de retorno:: float | None

property tolerancia_viabilidade_restricoes: float | None

A nova tolerância para a viabilidade das restrições.

Retorna:: A tolerância
Tipo de retorno:: float | None

property valor_final_variaveis_folga: float | None

O valor final ou máximo para as variáveis de folga.

Retorna:: O valor máximo
Tipo de retorno:: float | None

property valor_inicial_variaveis_folga: float | None

O valor inicial ou mínimo para as variáveis de folga.

Retorna:: O valor mínimo
Tipo de retorno:: float | None

class CX(previous=None, next=None, data=None)[código-fonte]

Registro que mapeia o acoplamento de usinas que representam complexos no NEWAVE com o DECOMP.

property codigo_decomp: int | None

O código da usina no DECOMP

Retorna:: O código
Tipo de retorno:: int | None

property codigo_newave: int | None

O código da usina no NEWAVE

Retorna:: O código
Tipo de retorno:: int | None

class FA(previous=None, next=None, data=None)[código-fonte]

Registro que indica o nome do arquivo índice CSV.

property arquivo: str | None

O nome do arquivo índice CSV.

Retorna:: O nome do arquivo
Tipo de retorno:: str | None

class VT(previous=None, next=None, data=None)[código-fonte]

Registro que indica o nome do arquivo com cenários de vento.

property arquivo: str | None

O nome do arquivo com cenários de vento.

Retorna:: O nome do arquivo
Tipo de retorno:: str | None

class CS(previous=None, next=None, data=None)[código-fonte]

Registro que habilita a consistência de dados.

property consistencia: int | None

Habilita ou não a consistência de dados.

Retorna:: O nvalor do flag
Tipo de retorno:: int | None

class VL(previous=None, next=None, data=None)[código-fonte]

Registro que define uma usina que sofre influência de vazão lateral na cota de jusante.

property codigo_usina_influenciada: int | None

O código da UHE influenciada.

Retorna:: O código
Tipo de retorno:: int | None

property coeficiente_a0: float | None

O coeficiente de grau 0 do polinômio de jusante.

Retorna:: O coeficiente de grau 0 do polinômio
Tipo de retorno:: float | None

property coeficiente_a1: float | None

O coeficiente de grau 1 do polinômio de jusante.

Retorna:: O coeficiente de grau 1 do polinômio
Tipo de retorno:: float | None

property coeficiente_a2: float | None

O coeficiente de grau 2 do polinômio de jusante.

Retorna:: O coeficiente de grau 2 do polinômio
Tipo de retorno:: float | None

property coeficiente_a3: float | None

O coeficiente de grau 3 do polinômio de jusante.

Retorna:: O coeficiente de grau 3 do polinômio
Tipo de retorno:: float | None

property coeficiente_a4: float | None

O coeficiente de grau 4 do polinômio de jusante.

Retorna:: O coeficiente de grau 4 do polinômio
Tipo de retorno:: float | None

property fator_impacto_defluencia: float | None

O fator de impacto referente a defluência da usina influenciada.

Retorna:: O fator da defluência
Tipo de retorno:: float | None

class VA(previous=None, next=None, data=None)[código-fonte]

Registro que define um posto de vazão que tem influência sobre a vazão de jusante da primeira.

property codigo_posto_influenciador: int | None

O código do posto cuja vazão incremental influencia lateralmente.

Retorna:: O código
Tipo de retorno:: int | None

property codigo_usina_influenciada: int | None

O código da UHE influenciada.

Retorna:: O código
Tipo de retorno:: int | None

property fator_impacto_incremental: float | None

O fator de impacto referente a incremental do posto influenciador.

Retorna:: O fator da vazão incremental
Tipo de retorno:: float | None

class VU(previous=None, next=None, data=None)[código-fonte]

Registro que define uma usina que tem influência sobre a vazão de jusante da primeira.

property codigo_usina_influenciada: int | None

O código da UHE influenciada.

Retorna:: O código
Tipo de retorno:: int | None

property codigo_usina_influenciadora: int | None

O código da UHE cuja vazão defluente influencia lateralmente.

Retorna:: O código
Tipo de retorno:: int | None

property fator_impacto_defluencia: float | None

O fator de impacto referente a defluência da usina influenciadora.

Retorna:: O fator da defluência
Tipo de retorno:: float | None

class DA(previous=None, next=None, data=None)[código-fonte]

Registro que contém as retiradas de água para outros usos (desvios de água) por UHE.

property codigo_usina_retirada: int | None

O código da UHE a montante da qual será feita a retirada.

Retorna:: O código
Tipo de retorno:: int | None

property codigo_usina_retorno: int | None

O código da UHE a montante da qual se derá o retorno.

Retorna:: O código
Tipo de retorno:: int | None

property custo: float | None

O custo de não antedimento do desvio em $/hm³.

Retorna:: O custo
Tipo de retorno:: float | None

property estagio: int | None

O estágio associado à restrição DA.

Retorna:: O estágio
Tipo de retorno:: int | None

property retorno_percentual: float | None

O retorno em percentual da vazão desviada.

Retorna:: O retorno percentual
Tipo de retorno:: float | None

property vazao_desviada: float | None

A vazão a ser desviada em m³/s.

Retorna:: A vazão
Tipo de retorno:: float | None

class ACNUMPOS(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração no número do posto.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACNUMJUS(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração na usina de jusante.

property ano: int | None

O ano de validade da alteração de cadastro.

Retorna:: O ano como int

property codigo_usina: int | None

O número da UHE conforme registro UH.

Retorna:: O número da UHE como int.

property codigo_usina_jusante: int | None

O número da UHE de jusante conforme registro UH.

Retorna:: O número da UHE como int.

property mes: str | None

O mês de validade da alteração de cadastro.

Retorna:: O mês como str.

property semana: int | None

A semana de validade da alteração de cadastro.

Retorna:: A semana como int

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACDESVIO(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração na usina de jusante para canal de desvio e limite da vazão no canal.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACVOLMIN(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração de volume mínimo.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACVOLMAX(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração de volume máximo.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACCOTVOL(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração de um coeficiente do polinômio cota-volume.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACCOTARE(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração de um coeficiente do polinômio cota-área.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACPROESP(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do coeficiente de perdas hidráulicas em função da queda bruta (%,m,k).

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACPERHID(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do coeficiente de perdas hidráulicas em função da queda bruta (%,m,k).

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACNCHAVE(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do número da curva-chave (cota-vazão) e nível de jusante da faixa associada (m).

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACCOTVAZ(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração de um coeficiente do polinômio cota-vazão.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACCOFEVA(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do coeficiente de evaporação mensal para cada mês.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACNUMCON(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração no número de conjuntos de máquinas.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACNUMMAQ(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do número de máquinas em cada conjunto de máquinas.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACPOTEFE(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração da potência efetiva por unidade geradora em um conjunto de máquinas.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACALTEFE(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração da altura efetiva de queda para um conjunto de máquinas.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACVAZEFE(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração da vazão efetiva para um conjunto de máquinas.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACJUSMED(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração da cota média do canal de fuga em metros.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACVERTJU(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para consideração da influência do vertimento no canal de fuga.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACVAZMIN(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração da vazão mínima.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACTIPERH(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do tipo de perdas hidráulicas.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACJUSENA(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do índice de aproveitamento de jusante para cálculo das energias armazenada e afluente.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACVSVERT(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do volume mínimo para operação do vertedor.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACVMDESV(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do volume mínimo para operação do canal de desvio.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool

class ACNPOSNW(previous=None, next=None, data=None)[código-fonte]

Registro AC específico para alteração do posto de acoplamento com o NEWAVE.

write(file: IO, storage: str = '', *args, **kwargs) → bool[código-fonte]

Generic function to perform the writing of the register using a filepointer.

Parâmetros:: file (IO) – The filepointer
Retorna:: The success, or not, in the writing
Tipo de retorno:: bool