Initial and parameter field files

The inifield file contains the initial conditions and spatial parameter input fields for a D-Flow FM model.

Generic parsing and serializing functionality comes from the generic hydrolib.core.io.ini modules.

The inifield file is represented by the classes below.

Model

AbstractSpatialField (INIBasedModel, ABC) pydantic-model

Abstract base class for [Initial] and [Parameter] block data in inifield files.

Defines all common fields. Used via subclasses InitialField and ParameterField.

AveragingType (str, Enum)

Enum class containing the valid values for the averagingType attribute in several subclasses of AbstractIniField.

DataFileType (str, Enum)

Enum class containing the valid values for the dataFileType attribute in several subclasses of AbstractIniField.

IniFieldGeneral (INIGeneral) pydantic-model

The initial field file's [General] section with file meta data.

IniFieldModel (INIModel) pydantic-model

The overall inifield model that contains the contents of one initial field and parameter file.

This model is typically referenced under a FMModel.geometry.inifieldfile[..].

Attributes:

Name	Type	Description
general	IniFieldGeneral	[General] block with file metadata.
initial	List[InitialField]	List of [Initial] blocks with initial condition definitions.
parameter	List[ParameterField]	List of [Parameter] blocks with spatial parameter definitions.

InitialField (AbstractSpatialField) pydantic-model

Initial condition field definition, represents an [Initial] block in an inifield file. Typically inside the definition list of a FMModel.geometry.inifieldfile.initial[..]

InterpolationMethod (str, Enum)

Enum class containing the valid values for the interpolationMethod attribute in several subclasses of AbstractIniField.

LocationType (str, Enum)

Enum class containing the valid values for the locationType attribute in several subclasses of AbstractIniField.

Operand (str, Enum)

Enum class containing the valid values for the operand attribute in several subclasses of AbstractIniField.

ParameterField (AbstractSpatialField) pydantic-model

Parameter field definition, represents a [Parameter] block in an inifield file. Typically inside the definition list of a FMModel.geometry.inifieldfile.parameter[..]