from __future__ import annotations
from dataclasses import dataclass
import os
from typing import Optional, MutableMapping
from ResSimpy.Nexus.DataModels.NexusFile import NexusFile
from ResSimpy.Nexus.DataModels.NexusEquilMethod import NexusEquilMethod
from ResSimpy.Equilibration import Equilibration
[docs]@dataclass(kw_only=True)
class NexusEquilMethods(Equilibration):
"""Class for collection of Nexus equilibration methods.
Attributes:
inputs (dict[int, NexusEquilMethod]): Collection of Nexus equilibration methods, as a dictionary
files (dict[int, NexusFile]): Dictionary collection of equilibration files, as defined in Nexus fcs file.
"""
__inputs: MutableMapping[int, NexusEquilMethod]
__files: dict[int, NexusFile]
__properties_loaded: bool = False # Used in lazy loading
[docs] def __init__(self, inputs: Optional[MutableMapping[int, NexusEquilMethod]] = None,
files: Optional[dict[int, NexusFile]] = None) -> None:
if inputs:
self.__inputs = inputs
else:
self.__inputs: MutableMapping[int, NexusEquilMethod] = {}
if files:
self.__files = files
else:
self.__files = {}
super().__init__()
def __repr__(self) -> str:
"""Pretty printing equil methods."""
if not self.__properties_loaded:
self.load_equil_methods()
printable_str = ''
for table_num in self.__inputs.keys():
printable_str += '\n--------------------------------\n'
printable_str += f'EQUIL method {table_num}\n'
printable_str += '--------------------------------\n'
printable_str += self.__inputs[table_num].__repr__()
printable_str += '\n'
return printable_str
@property
def inputs(self) -> MutableMapping[int, NexusEquilMethod]:
if not self.__properties_loaded:
self.load_equil_methods()
return self.__inputs
@property
def files(self) -> dict[int, NexusFile]:
return self.__files
def load_equil_methods(self):
# Read in equil properties from Nexus equil method files
if self.__files is not None and len(self.__files) > 0: # Check if equil files exist
for table_num in self.__files.keys(): # For each equil property method
equil_file = self.__files[table_num]
if equil_file.location is None:
raise ValueError(f'Unable to find equil file: {equil_file}')
if os.path.isfile(equil_file.location):
# Create NexusEquilMethod object
self.__inputs[table_num] = NexusEquilMethod(file=equil_file, input_number=table_num)
self.__inputs[table_num].read_properties() # Populate object with equil properties in file
self.__properties_loaded = True