Friction

1D roughness .ini files

The friction module provides the specific logic for accessing friction/1D roughness files for a D-Flow FM model.

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

A 1D roughness file is described by the classes below.

Model

FrictBranch (INIBasedModel) pydantic-model

A [Branch] block for use inside a friction file.

Each block can define the roughness value(s) on a particular branch.

FrictGeneral (INIGeneral) pydantic-model

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

FrictGlobal (INIBasedModel) pydantic-model

A [Global] block for use inside a friction file.

Multiple of such blocks may be present to define multiple frictionId classes.

FrictionModel (INIModel) pydantic-model

The overall friction model that contains the contents of one friction file.

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

Attributes:

Name	Type	Description
general	FrictGeneral	[General] block with file metadata.
global_	List[FrictGlobal]	Definitions of [Global] friction classes.
branch	List[FrictBranch]	Definitions of [Branch] friction values.

FrictionType (str, Enum)

Enum class containing the valid values for the frictionType attribute in several subclasses of Structure/CrossSection/friction.models.

chezy

str: Chézy C [m 1/2 /s]

debosbijkerk

str: De Bos-Bijkerk γ [1/s]

manning

str: Manning n [s/m 1/3 ]

strickler

str: Strickler k_s [m 1/3 /s]

stricklernikuradse

str: Nikuradse k_n [m]

walllawnikuradse

str: Nikuradse k_n [m]

whitecolebrook

str: Nikuradse k_n [m]