Dados gerais (dadger.rvX)

Visão geral do modelo

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(dados: idecomp._utils.dadosarquivo.DadosArquivoRegistros)[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.

Atualmente, são suportados os registros: TE, SB, UH, CT, DP, TX, GP, NI, DT, RE, LU, VI, IR, FC, TI, HV, LV, HQ, LQ HE, EV e FJ.

É possível ler as informações existentes em arquivos a partir do método le_arquivo() e escreve um novo arquivo a partir do método escreve_arquivo().

ac(uhe: int, modificacao: str, mes: Optional[str] = None, semana: Optional[int] = None, ano: Optional[int] = None)idecomp.decomp.modelos.dadger.AC[código fonte]

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

Parâmetros
  • uhe (int) – código da UHE modificada

  • modificacao (str) – mnemônico da modificação realizada

Retorna

Um registro do tipo AC

cd(numero_curva: int, subsistema: int)idecomp.decomp.modelos.dadger.CD[código fonte]

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

Parâmetros
  • numero_curva (int) – Índice da curva de déficit descrita

  • subsistema (int) – Índice do subsistema para o qual valerá a curva.

Retorna

Um registro do tipo CD

ct(codigo: int, estagio: int)idecomp.decomp.modelos.dadger.CT[código fonte]

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

Parâmetros
  • codigo (int) – Índice do código que especifica o registro da UTE

  • estagio (int) – Índice do estágio associado ao registro

Retorna

Um registro do tipo CT

dp(estagio: int, subsistema: int)idecomp.decomp.modelos.dadger.DP[código fonte]

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

Parâmetros
  • estagio (int) – Índice do estágio sobre o qual serão definidas as durações dos patamares

  • subsistema (int) – Índice do subsistema para o qual valerão os patamares.

Retorna

Um registro do tipo DP

property dt: idecomp.decomp.modelos.dadger.DT

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

Retorna

Um registro do tipo DT.

escreve_arquivo(diretorio: str, nome_arquivo='dadger.rv0')[código fonte]

Realiza a escrita de um arquivo com as informações do objeto Dadger

Parâmetros
  • diretorio (str) – O caminho relativo ou completo para o diretório onde será escrito o arquivo.

  • nome_arquivo (str, optional) – Nome do arquivo a ser escrito.Tem como valor default “dadger.rv0”

property ev: idecomp.decomp.modelos.dadger.EV

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

Retorna

Um registro do tipo EV.

fc(tipo: str)idecomp.decomp.modelos.dadger.FC[código fonte]

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

Parâmetros

tipo (str) – Mnemônico do tipo de FCF especificado no registro

Retorna

Um registro do tipo FC

property fj: idecomp.decomp.modelos.dadger.FJ

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

Retorna

Um registro do tipo FJ.

fp(codigo: int, estagio: int)idecomp.decomp.modelos.dadger.FP[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 (int) – Código do posto da UHE associada no registro

  • estagio (int) – Estágio de definição da FP da UHE

Retorna

Um registro do tipo FP

property gp: idecomp.decomp.modelos.dadger.GP

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

Retorna

Um registro do tipo GP.

he(codigo: int, estagio: int)idecomp.decomp.modelos.dadger.HE[código fonte]

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

Parâmetros
  • codigo (int) – Índice do código que especifica o registro da restrição de energia armazenada

  • estagio (int) – Índice do estágio para o qual vale a restrição de energia armazenada

Retorna

Um registro do tipo HE

hq(codigo: int)idecomp.decomp.modelos.dadger.HQ[código fonte]

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

Parâmetros

codigo (int) – Índice do código que especifica o registro da restrição de vazão

Retorna

Um registro do tipo HQ

hv(codigo: int)idecomp.decomp.modelos.dadger.HV[código fonte]

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

Parâmetros

codigo (int) – Índice do código que especifica o registro da restrição de volume mínimo

Retorna

Um registro do tipo HV

ir(tipo: str)idecomp.decomp.modelos.dadger.IR[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) – Mnemônico do tipo de relatório especificado no registro

Retorna

Um registro do tipo IR

classmethod le_arquivo(diretorio: str, nome_arquivo='dadger.rv0')idecomp.decomp.dadger.Dadger[código fonte]

Realiza a leitura de um arquivo “dadger.rvx” existente em um diretório.

Parâmetros
  • diretorio (str) – O caminho relativo ou completo para o diretório onde se encontra o arquivo

  • nome_arquivo (str, optional) – Nome do arquivo a ser lido, potencialmente especificando a revisão. Tem como valor default “dadger.rv0”

Retorna

Um objeto Dadger com informações do arquivo lido

lq(codigo: int, estagio: int)idecomp.decomp.modelos.dadger.LQ[código fonte]

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 (int) – Índice do código que especifica o registro da restrição de vazão

  • estagio (int) – Estágio sobre o qual valerão os limites da restrição de vazão

Retorna

Um registro do tipo LQ

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
lu(codigo: int, estagio: int)idecomp.decomp.modelos.dadger.LU[código fonte]

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 (int) – Índice do código que especifica o registro da restrição elétrica

  • estagio (int) – Estágio sobre o qual valerão os limites da restrição elétricas

Retorna

Um registro do tipo LU

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
lv(codigo: int, estagio: int)idecomp.decomp.modelos.dadger.LV[código fonte]

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 (int) – Índice do código que especifica o registro da restrição de volume mínimo

  • estagio (int) – Estágio sobre o qual valerão os limites da restrição

Retorna

Um registro do tipo LV

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
property ni: idecomp.decomp.modelos.dadger.NI

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 do tipo NI.

re(codigo: int)idecomp.decomp.modelos.dadger.RE[código fonte]

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

Parâmetros

codigo (int) – Índice do código que especifica o registro da restrição elétrica

Retorna

Um registro do tipo RE

rq(ree: int)idecomp.decomp.modelos.dadger.RQ[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

ree (int) – Código do REE

Retorna

Um registro do tipo RQ

rt(mnemonico: str)idecomp.decomp.modelos.dadger.RT[código fonte]

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

Parâmetros

mnemonico (str) – Mnemônico da restrição retirada (CRISTA ou DESVIO)

Retorna

Um registro do tipo RT

sb(codigo: int)idecomp.decomp.modelos.dadger.SB[código fonte]

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

Parâmetros

codigo (int) – Índice do código que especifica o registro do subsistema

Retorna

Um registro do tipo SB

property te: idecomp.decomp.modelos.dadger.TE

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

Retorna

Um registro do tipo TE.

ti(codigo: int)idecomp.decomp.modelos.dadger.TI[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 (int) – Código do posto da UHE associada no registro

Retorna

Um registro do tipo TI

property tx: idecomp.decomp.modelos.dadger.TX

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

Retorna

Um registro do tipo TX.

uh(codigo: int)idecomp.decomp.modelos.dadger.UH[código fonte]

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

Parâmetros

codigo (int) – Índice do código que especifica o registro da UHE

Retorna

Um registro do tipo UH

ve(codigo: int)idecomp.decomp.modelos.dadger.VE[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 (int) – Código do posto da UHE associada

Retorna

Um registro do tipo VE

vi(uhe: int)idecomp.decomp.modelos.dadger.VI[código fonte]

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

Parâmetros

uhe (int) – Índice da UHE associada aos tempos de viagem

Retorna

Um registro do tipo VI

Registros

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[código fonte]

Registro que contém o nome do estudo do DECOMP.

property titulo: str

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

Retorna

Uma str com o título do estudo

class SB[código fonte]

Registro que contém o cadastro dos subsistemas.

property codigo: int

O código de cadastro do subsistema.

Retorna

O código como int.

property nome: str

O nome de cadastro do subsistema.

Retorna

O nome como str.

class UH[código fonte]

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

property codigo: int

O código de cadastro da UHE.

Retorna

O código como um int.

property evaporacao: bool

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

Retorna

A consideração como um bool.

property ree: int

O REE de cadastro da UHE.

Retorna

O REE como um int.

property volume_inicial: float

O volume inicial da UHE para o estudo.

Retorna

O volume como um float.

class CT[código fonte]

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

property codigo: int

O código de cadastro da UTE.

Retorna

O código como um int.

property cvus: List[float]

Os CVUs da UTE por patamar.

Retorna

Os CVUs como list[float].

property disponibilidades: List[float]

As disponibilidades da UTE por patamar.

Retorna

As disponibilidades como list[float].

property estagio: str

O estágio associado às propriedades cadastradas.

Retorna

O estágio como um int.

property inflexibilidades: List[float]

As inflexibilidades da UTE por patamar.

Retorna

As inflexibilidades como list[float].

property nome: str

O nome de cadastro da UTE.

Retorna

O nome como uma str.

property subsistema: int

O subsistema de cadastro da UTE.

Retorna

O subsistema como um int.

class UE[código fonte]

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

class DP[código fonte]

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

property cargas: List[float]

As cargas em Mwmed pata cada patamar de carga

Retorna

As cargas como list[float].

property duracoes: List[float]

As durações de cada patamar de carga em horas

Retorna

As durações como list[float].

property estagio: int

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

Retorna

O estágio como int.

property num_patamares: int

O número de patamares.

Retorna

O número como int.

property subsistema: int

O subsistema associado às durações especificadas.

Retorna

O subsistema como int.

class CD[código fonte]

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

class PQ[código fonte]

Registro que contém as gerações de pequenas usinas, não incluídas no despacho.

class RI[código fonte]

Registro que contém as restrições de Itaipu.

class IA[código fonte]

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

class TX[código fonte]

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

property taxa: float

A taxa de desconto em % utilizada no estudo

Retorna

As taxa como float.

class GP[código fonte]

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

property gap: float

O gap considerado para convergência no estudo

Retorna

O gap como float.

class NI[código fonte]

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

property iteracoes: int

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

Retorna

O número de iterações como int.

class DT[código fonte]

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

property ano: int

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

Retorna

O ano como int.

property dia: int

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

Retorna

O dia como int.

property mes: int

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

Retorna

O mês como int.

class MP[código fonte]

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

class MT[código fonte]

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

class FD[código fonte]

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

class VE[código fonte]

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

property codigo: int

O código do posto associado ao volume

Retorna

O código como int.

class RE[código fonte]

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

property codigo: int

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

Retorna

O código como int.

property estagio_final: int

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

Retorna

O estágio como int.

property estagio_inicial: int

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

Retorna

O estágio como int.

class LU[código fonte]

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

property codigo: int

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

Retorna

O código como int.

property estagio: int

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

Retorna

O estágio como int.

property limites_inferiores: List[float]

Os limites inferiores por patamar para a restrição elétrica

Retorna

Os limites como list[float]

property limites_superiores: List[float]

Os limites superiores por patamar para a restrição elétrica

Retorna

Os limites como list[float]

class FU[código fonte]

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

class FT[código fonte]

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

class FI[código fonte]

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

class VI[código fonte]

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

property duracao: int

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 como int

property uhe: int

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

Retorna

O código como int

property vazoes: List[float]

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

A duração como int

class AC[código fonte]

Registro que contém as alterações de cadastro das usinas hidrelétricas.

class IR[código fonte]

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

property tipo: str

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

Retorna

O mnemônico como str.

class CI[código fonte]

Registro que define contratos de importação de energia.

class CE[código fonte]

Registro que define contratos de importação de energia.

class FC[código fonte]

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

property caminho: str

O caminho relativo ou completo para o arquivo da FCF.

Retorna

O caminho como str.

property tipo: str

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

Retorna

O mnemônico como str.

class RT[código fonte]

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

property restricao: str

O mnemônico da restrição removida.

Retorna

O mnemônico como str.

class TI[código fonte]

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

property codigo: int

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

Retorna

O código como int.

property taxas: List[float]

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 como list[float].

class RQ[código fonte]

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

property ree: int

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

Retorna

O código como int.

property vazoes: List[float]

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

Retorna

As vazoes como list[float].

class EZ[código fonte]

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

class HV[código fonte]

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

property codigo: int

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

Retorna

O código como int.

property estagio_final: int

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

Retorna

O estágio como int.

property estagio_inicial: int

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

Retorna

O estágio como int.

class LV[código fonte]

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

property codigo: int

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

Retorna

O código como int.

property estagio: int

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

Retorna

O estágio como int.

property limite_inferior: float

O limite inferior para o armazenamento.

Retorna

O limite como float.

property limites_superior: float

O limite superior para o armazenamento.

Retorna

O limite como float.

class CV[código fonte]

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

class HQ[código fonte]

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

property codigo: int

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

Retorna

O código como int.

property estagio_final: int

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

Retorna

O estágio como int.

property estagio_inicial: int

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

Retorna

O estágio como int.

class LQ[código fonte]

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

property codigo: int

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

Retorna

O código como int.

property estagio: int

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

Retorna

O estágio como int.

property limites_inferiores: List[float]

Os limites inferiores por patamar para a vazão.

Retorna

Os limites como list[float].

property limites_superiores: List[float]

Os limites superiores por patamar para a vazão.

Retorna

Os limites como list[float].

class CQ[código fonte]

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

class AR[código fonte]

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

class EV[código fonte]

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

class FJ[código fonte]

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

class HE[código fonte]

Registro que contém o cadastro de uma restrição de volume mínimo armazenado.

property codigo: int

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

Retorna

O código como int.

property estagio: int

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

Retorna

O estágio como int.

property limite: float

O limite para a energia armazenada associada ao registro HE.

Retorna

O limite como float.

property penalidade: float

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

Retorna

O valor como float.

property tipo_limite: int

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

Retorna

O tipo como int.

property tipo_penalidade: int

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

Retorna

O tipo como int.

class CM[código fonte]

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