ResSimpy.Nexus.DataModels.NexusWaterMethod.NexusWaterMethod

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

Bases: DynamicProperty

Class to hold Nexus Water properties.

file

Nexus water file object

Type:: NexusFile

input_number

Water method number in Nexus fcs file

Type:: int

reference_pressure

Reference pressure for BW and, if CVW is present, for VISW

Type:: float

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

Dictionary holding properties for generic dynamic method. Defaults to empty dictionary.

parameters

list of water parameters, such as density, viscosity, etc.

Type:: list[NexusWaterParams]

Public Data Attributes:

`reference_pressure`
`file`
`properties`
`parameters`

Inherited from DynamicProperty

`input_number`
`file`

Methods:

`__init__`(file, input_number[, ...])
`nexus_mapping`()	Returns a dictionary of mapping from nexus keyword to attribute name.
`to_string`()	Create string with water data, in Nexus file format.
`read_properties`()	Read Nexus Water file contents and populate NexusWaterMethod 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, reference_pressure: float | None = None, properties: dict[str, Union[str, int, float, enum.Enum, list[str], pandas.DataFrame, dict[str, Union[float, pandas.DataFrame]]]] | None = None, parameters: list[ResSimpy.Nexus.DataModels.NexusWaterMethod.NexusWaterParams] | None = None) → None[source]

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

static nexus_mapping() → dict[str, tuple[str, type]][source]: Returns a dictionary of mapping from nexus keyword to attribute name.

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

read_properties() → None[source]: Read Nexus Water file contents and populate NexusWaterMethod object.