ResSimpy.Nexus.DataModels.NexusRelPermMethod.NexusRelPermMethod

class ResSimpy.Nexus.DataModels.NexusRelPermMethod.NexusRelPermMethod(file: NexusFile, input_number: int, properties: dict[str, Union[str, int, float, enum.Enum, list[str], pandas.DataFrame, dict[str, Union[float, pandas.DataFrame]]]] | None = None, hysteresis_params: dict[str, Union[str, float, dict[str, Union[str, float, dict[str, Union[str, float]]]]]] | None = None)[source]

Bases: DynamicProperty

Class to hold Nexus relative permeability and capillary pressure properties.

file

Nexus relperm file object

Type:: NexusFile

input_number

RELPM method number in Nexus fcs file

Type:: int

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:

`file`
`properties`
`hysteresis_params`

Inherited from DynamicProperty

`input_number`
`file`

Methods:

`__init__`(file, input_number[, properties, ...])
`to_string`()	Create string with relative permeability and capillary pressure data, in Nexus file format.
`read_properties`()	Read Nexus rel perm file contents and populate the NexusRelPermMethod 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, properties: dict[str, Union[str, int, float, enum.Enum, list[str], pandas.DataFrame, dict[str, Union[float, pandas.DataFrame]]]] | None = None, hysteresis_params: dict[str, Union[str, float, dict[str, Union[str, float, dict[str, Union[str, float]]]]]] | 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 relative permeability and capillary pressure data, in Nexus file format.

read_properties() → None[source]: Read Nexus rel perm file contents and populate the NexusRelPermMethod object.