Modificações das Hidrelétricas (modif.dat)

As modificações nas configurações das hidrelétricas do NEWAVE, localizadas no arquivo geralmente denominado modif.dat, são armazenadas na classe:

class Modif(data: RegisterData = <cfinterface.data.registerdata.RegisterData object>)[código-fonte]

Armazena os dados de entrada do NEWAVE referentes às alterações nas configurações das usinas hidroelétricas.

As palavras-chave só são reconhecidas em maiúsculas. O manual do NEWAVE (seção 3.12) também admite palavras-chave em minúsculas, mas uma linha assim não é lida como registro: é mantida como texto e reescrita sem alterações.

Um valor que não pode ser lido como número é lido como None, da mesma forma que um valor opcional não informado, como a vazão máxima do CDESVIO.

cdesvio(codigo_usina_jusante: int | None = None, limite_vazao: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
cdesvio(codigo_usina_jusante: int | None = None, limite_vazao: float | None = None, df: Literal[False] = False) → CDESVIO | List[CDESVIO] | None
cdesvio(codigo_usina_jusante: int | None = None, limite_vazao: float | None = None, df: bool = False) → CDESVIO | List[CDESVIO] | DataFrame | None

Obtém um registro que define o canal de desvio da usina.

Parâmetros:
  • codigo_usina_jusante (int | None) – a usina a jusante no canal de desvio

  • limite_vazao (float | None) – a vazão máxima do canal de desvio em m3/s

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

CDESVIO | list[CDESVIO] | pd.DataFrame | None

cfuga(data_inicio: datetime | None = None, nivel: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
cfuga(data_inicio: datetime | None = None, nivel: float | None = None, df: Literal[False] = False) → CFUGA | List[CFUGA] | None
cfuga(data_inicio: datetime | None = None, nivel: float | None = None, df: bool = False) → CFUGA | List[CFUGA] | DataFrame | None

Obtém um registro que define o nível do canal de fuga.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do nível

  • nivel (float | None) – o nível

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

CFUGA | list[CFUGA] | pd.DataFrame | None

cmont(data_inicio: datetime | None = None, nivel: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
cmont(data_inicio: datetime | None = None, nivel: float | None = None, df: Literal[False] = False) → CMONT | List[CMONT] | None
cmont(data_inicio: datetime | None = None, nivel: float | None = None, df: bool = False) → CMONT | List[CMONT] | DataFrame | None

Obtém um registro que define o nível do canal de montante.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do nível

  • nivel (float | None) – o nível

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

CMONT | list[CMONT] | pd.DataFrame | None

coefevap(coeficiente: int | None = None, mes: int | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
coefevap(coeficiente: int | None = None, mes: int | None = None, df: Literal[False] = False) → COEFEVAP | List[COEFEVAP] | None
coefevap(coeficiente: int | None = None, mes: int | None = None, df: bool = False) → COEFEVAP | List[COEFEVAP] | DataFrame | None
Obtém um registro que define o coeficiente de evaporação de um

mês.

Parâmetros:
  • coeficiente (int | None) – o coeficiente de evaporação em mm/mês

  • mes (int | None) – o mês do coeficiente (1 a 12)

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

COEFEVAP | list[COEFEVAP] | pd.DataFrame | None

cotarea(polinomio_cota_area: List[float] | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
cotarea(polinomio_cota_area: List[float] | None = None, df: Literal[False] = False) → COTAREA | List[COTAREA] | None
cotarea(polinomio_cota_area: List[float] | None = None, df: bool = False) → COTAREA | List[COTAREA] | DataFrame | None

Obtém um registro que define o polinômio cota-área.

Parâmetros:

polinomio_cota_area (list[float] | None) – os coeficientes a0 a a4

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

COTAREA | list[COTAREA] | pd.DataFrame | None

ip(ip: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
ip(ip: float | None = None, df: Literal[False] = False) → IP | List[IP] | None
ip(ip: float | None = None, df: bool = False) → IP | List[IP] | DataFrame | None

Obtém um registro que define a indisponibilidade programada.

Parâmetros:

ip (float | None) – a indisponibilidade programada em %

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

IP | list[IP] | pd.DataFrame | None

modificacoes_usina(codigo: int) → List[Register] | None[código-fonte]

Filtra os registros que são associados a uma usina específica.

Retorna os registros entre o registro USINA da usina e o próximo USINA (ou o fim do arquivo). O manual do NEWAVE (seção 3.12) admite no máximo um bloco de modificações por usina; se o arquivo tiver mais de um bloco para a mesma usina, apenas o primeiro é considerado e os demais são ignorados. Para percorrer todos os blocos, itere sobre self.data a partir de cada registro USINA retornado por usina().

Parâmetros:

codigo (int) – O código da usina

Retorna:

Os registros que modificam a usina, ou None se o arquivo não possuir nenhum registro USINA

Tipo de retorno:

List[Register] | None

numbas(numero: int | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
numbas(numero: int | None = None, df: Literal[False] = False) → NUMBAS | List[NUMBAS] | None
numbas(numero: int | None = None, df: bool = False) → NUMBAS | List[NUMBAS] | DataFrame | None

Obtém um registro que define o número de unidades de base.

Parâmetros:

numero (int | None) – o número de unidades de base

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

NUMBAS | list[NUMBAS] | pd.DataFrame | None

numcnj(numero: int | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
numcnj(numero: int | None = None, df: Literal[False] = False) → NUMCNJ | List[NUMCNJ] | None
numcnj(numero: int | None = None, df: bool = False) → NUMCNJ | List[NUMCNJ] | DataFrame | None

Obtém um registro que um número de conjuntos de máquinas.

Parâmetros:

numero (int | None) – o número

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

NUMCNJ | list[NUMCNJ] | pd.DataFrame | None

nummaq(conjunto: int | None = None, numero_maquinas: int | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
nummaq(conjunto: int | None = None, numero_maquinas: int | None = None, df: Literal[False] = False) → NUMMAQ | List[NUMMAQ] | None
nummaq(conjunto: int | None = None, numero_maquinas: int | None = None, df: bool = False) → NUMMAQ | List[NUMMAQ] | DataFrame | None
Obtém um registro que um número de máquinas por

conjunto de máquinas.

Parâmetros:
  • conjunto (int | None) – o conjunto

  • numero_maquinas (int | None) – o número de máquinas

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

NUMMAQ | list[NUMMAQ] | pd.DataFrame | None

perdhidr(perdas: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
perdhidr(perdas: float | None = None, df: Literal[False] = False) → PERDHIDR | List[PERDHIDR] | None
perdhidr(perdas: float | None = None, df: bool = False) → PERDHIDR | List[PERDHIDR] | DataFrame | None

Obtém um registro que define a perda hidráulica.

Parâmetros:

perdas (float | None) – a perda hidráulica, na unidade do cadastro

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

PERDHIDR | list[PERDHIDR] | pd.DataFrame | None

potefe(potencia: float | None = None, conjunto: int | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
potefe(potencia: float | None = None, conjunto: int | None = None, df: Literal[False] = False) → POTEFE | List[POTEFE] | None
potefe(potencia: float | None = None, conjunto: int | None = None, df: bool = False) → POTEFE | List[POTEFE] | DataFrame | None
Obtém um registro que define a potência efetiva de um

conjunto de máquinas.

Parâmetros:
  • potencia (float | None) – a potência efetiva em MW

  • conjunto (int | None) – o conjunto

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

POTEFE | list[POTEFE] | pd.DataFrame | None

prodesp(produtibilidade: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
prodesp(produtibilidade: float | None = None, df: Literal[False] = False) → PRODESP | List[PRODESP] | None
prodesp(produtibilidade: float | None = None, df: bool = False) → PRODESP | List[PRODESP] | DataFrame | None

Obtém um registro que define a produtibilidade específica.

Parâmetros:

produtibilidade (float | None) – a produtibilidade específica em MW/m3/s/m

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

PRODESP | list[PRODESP] | pd.DataFrame | None

teif(teif: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
teif(teif: float | None = None, df: Literal[False] = False) → TEIF | List[TEIF] | None
teif(teif: float | None = None, df: bool = False) → TEIF | List[TEIF] | DataFrame | None
Obtém um registro que define a taxa esperada de indisponibilidade

forçada.

Parâmetros:

teif (float | None) – a taxa esperada de indisponibilidade forçada em %

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

TEIF | list[TEIF] | pd.DataFrame | None

turbmaxt(data_inicio: datetime | None = None, turbinamento: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
turbmaxt(data_inicio: datetime | None = None, turbinamento: float | None = None, df: Literal[False] = False) → TURBMAXT | List[TURBMAXT] | None
turbmaxt(data_inicio: datetime | None = None, turbinamento: float | None = None, df: bool = False) → TURBMAXT | List[TURBMAXT] | DataFrame | None

Obtém um registro que define o turbinamento máximo por período.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do turbinamento

  • turbinamento (float | None) – o turbinamento máximo

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

TURBMAXT | list[TURBMAXT] | pd.DataFrame | None

turbmint(data_inicio: datetime | None = None, turbinamento: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
turbmint(data_inicio: datetime | None = None, turbinamento: float | None = None, df: Literal[False] = False) → TURBMINT | List[TURBMINT] | None
turbmint(data_inicio: datetime | None = None, turbinamento: float | None = None, df: bool = False) → TURBMINT | List[TURBMINT] | DataFrame | None

Obtém um registro que define o turbinamento mínimo por período.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do turbinamento

  • turbinamento (float | None) – o turbinamento mínimo

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

TURBMINT | list[TURBMINT] | pd.DataFrame | None

usina(codigo: int | None = None, nome: str | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
usina(codigo: int | None = None, nome: str | None = None, df: Literal[False] = False) → USINA | List[USINA] | None
usina(codigo: int | None = None, nome: str | None = None, df: bool = False) → USINA | List[USINA] | DataFrame | None

Obtém um registro que define a usina modificada.

Parâmetros:
  • codigo (int | None) – código da usina modificada

  • nome (str | None) – nome da usina

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

USINA | list[USINA] | pd.DataFrame | None

vazmaxt(data_inicio: datetime | None = None, vazao: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
vazmaxt(data_inicio: datetime | None = None, vazao: float | None = None, df: Literal[False] = False) → VAZMAXT | List[VAZMAXT] | None
vazmaxt(data_inicio: datetime | None = None, vazao: float | None = None, df: bool = False) → VAZMAXT | List[VAZMAXT] | DataFrame | None

Obtém um registro que define a vazão máxima por período.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do volume

  • vazao (float | None) – a vazão máxima

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VAZMAXT | list[VAZMAXT] | pd.DataFrame | None

vazmin(vazao: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
vazmin(vazao: float | None = None, df: Literal[False] = False) → VAZMIN | List[VAZMIN] | None
vazmin(vazao: float | None = None, df: bool = False) → VAZMIN | List[VAZMIN] | DataFrame | None

Obtém um registro que define uma vazão mínima.

Parâmetros:

vazao (float | None) – vazão mínima

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VAZMIN | list[VAZMIN] | pd.DataFrame | None

vazmint(data_inicio: datetime | None = None, vazao: float | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
vazmint(data_inicio: datetime | None = None, vazao: float | None = None, df: Literal[False] = False) → VAZMINT | List[VAZMINT] | None
vazmint(data_inicio: datetime | None = None, vazao: float | None = None, df: bool = False) → VAZMINT | List[VAZMINT] | DataFrame | None

Obtém um registro que define a vazão mínima por período.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do volume

  • vazao (float | None) – a vazão mínima

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VAZMINT | list[VAZMINT] | pd.DataFrame | None

vmaxt(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
vmaxt(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, df: Literal[False] = False) → VMAXT | List[VMAXT] | None
vmaxt(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, df: bool = False) → VMAXT | List[VMAXT] | DataFrame | None

Obtém um registro que define o volume máximo por período.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do volume

  • volume (float | None) – o volume

  • unidade (str | None) – a unidade do volume

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VMAXT | list[VMAXT] | pd.DataFrame | None

vminp(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
vminp(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, df: Literal[False] = False) → VMINP | List[VMINP] | None
vminp(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, df: bool = False) → VMINP | List[VMINP] | DataFrame | None

Obtém um registro que define o volume mínimo para penalidade.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do volume

  • volume (float | None) – o volume

  • unidade (str | None) – a unidade do volume

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VMINP | list[VMINP] | pd.DataFrame | None

vmint(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
vmint(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, df: Literal[False] = False) → VMINT | List[VMINT] | None
vmint(data_inicio: datetime | None = None, volume: float | None = None, unidade: str | None = None, df: bool = False) → VMINT | List[VMINT] | DataFrame | None

Obtém um registro que define o volume mínimo por período.

Parâmetros:
  • data_inicio (datetime | None) – data de início da validade do volume

  • volume (float | None) – o volume

  • unidade (str | None) – a unidade do volume

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VMINT | list[VMINT] | pd.DataFrame | None

volcota(polinomio_volume_cota: List[float] | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
volcota(polinomio_volume_cota: List[float] | None = None, df: Literal[False] = False) → VOLCOTA | List[VOLCOTA] | None
volcota(polinomio_volume_cota: List[float] | None = None, df: bool = False) → VOLCOTA | List[VOLCOTA] | DataFrame | None

Obtém um registro que define o polinômio volume-cota.

Parâmetros:

polinomio_volume_cota (list[float] | None) – os coeficientes a0 a a4

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VOLCOTA | list[VOLCOTA] | pd.DataFrame | None

volmax(volume: float | None = None, unidade: str | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
volmax(volume: float | None = None, unidade: str | None = None, df: Literal[False] = False) → VOLMAX | List[VOLMAX] | None
volmax(volume: float | None = None, unidade: str | None = None, df: bool = False) → VOLMAX | List[VOLMAX] | DataFrame | None

Obtém um registro que define um volume máximo.

Parâmetros:
  • volume (float | None) – volume máximo

  • unidade (str | None) – unidade do volume

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VOLMAX | list[VOLMAX] | pd.DataFrame | None

volmin(volume: float | None = None, unidade: str | None = None, *, df: Literal[True]) → DataFrame[código-fonte]
volmin(volume: float | None = None, unidade: str | None = None, df: Literal[False] = False) → VOLMIN | List[VOLMIN] | None
volmin(volume: float | None = None, unidade: str | None = None, df: bool = False) → VOLMIN | List[VOLMIN] | DataFrame | None

Obtém um registro que define um volume mínimo.

Parâmetros:
  • volume (float | None) – volume mínimo

  • unidade (str | None) – unidade do volume

Retorna:

Um ou mais registros, se existirem.

Tipo de retorno:

VOLMIN | list[VOLMIN] | pd.DataFrame | None