ResSimpy.Nexus.DataModels.NexusPVTMethod.NexusPVTMethod

class ResSimpy.Nexus.DataModels.NexusPVTMethod.NexusPVTMethod(file: NexusFile, input_number: int, pvt_type: str | None = None, eos_nhc: int | None = None, eos_temp: float | None = None, eos_components: list[str] | None = None, eos_options: dict[str, Union[str, int, float, pandas.DataFrame, list[str], dict[str, float], tuple[str, dict[str, float]], dict[str, pandas.DataFrame]]] | None = None, properties: dict[str, Union[str, int, float, enum.Enum, list[str], pandas.DataFrame, dict[str, Union[float, pandas.DataFrame]]]] | None = None)[source]

Bases: DynamicProperty

Class to hold Nexus PVT properties.

file

Nexus PVT file object

Type:: NexusFile

input_number

PVT method number in Nexus fcs file

Type:: int

pvt_type

Type of PVT method, e.g., BLACKOIL, GASWATER or EOS. Defaults to None

Type:: Optional[str]

eos_nhc

Number of hydrocarbon components. Defaults to None

Type:: Optional[int]

eos_temp

Default temperature for EOS method. Defaults to None

Type:: Optional[float]

eos_components

Specifies component names

Type:: Optional[list[str]]

eos_options (dict[str, Union[str, int, float, pd.DataFrame, list[str], dict[str, float],: tuple[str, dict[str, float]], dict[str, pd.DataFrame]]]): Dictionary containing various EOS options as specified in the PVT file. Defaults to empty dictionary.

properties (dict[str, Union[str, int, float, Enum, list[str], pd.DataFrame,: dict[str, Union[float, pd.DataFrame]]]]):

Dictionary holding all properties for a specific PVT method. Defaults to empty dictionary.

Public Data Attributes:

`pvt_type`
`eos_nhc`
`eos_temp`
`file`
`eos_components`
`eos_options`
`properties`

Inherited from DynamicProperty

`input_number`
`file`

Methods:

`__init__`(file, input_number[, pvt_type, ...])
`to_string`()	Create string with PVT data in Nexus file format.
`read_properties`()	Read Nexus PVT file contents and populate the NexusPVTMethod object.
`__eq__`(other)	Return self==value.

Inherited from DynamicProperty

`__init__`(input_number, file)
`__repr__`()	Pretty printing dynamic property data.
`to_string`()	Write dynamic property data to string.
`write_to_file`([overwrite_existing, ...])	Write dynamic property data to file.
`__eq__`(other)	Return self==value.

__init__(file: NexusFile, input_number: int, pvt_type: str | None = None, eos_nhc: int | None = None, eos_temp: float | None = None, eos_components: list[str] | None = None, eos_options: dict[str, Union[str, int, float, pandas.DataFrame, list[str], dict[str, float], tuple[str, dict[str, float]], dict[str, pandas.DataFrame]]] | None = None, properties: dict[str, Union[str, int, float, enum.Enum, list[str], pandas.DataFrame, dict[str, Union[float, pandas.DataFrame]]]] | None = None) → None[source]

write_to_file(overwrite_existing: bool = False, new_file_location: str | None = None) → None: Write dynamic property data to file.

to_string() → str[source]: Create string with PVT data in Nexus file format.

read_properties() → None[source]: Read Nexus PVT file contents and populate the NexusPVTMethod object.