PipingSettings

PipingSettings()

A dataclass to store various settings and parameters related to piping calculations.

Attributes

Name	Type	Description
t_norm	float or np.ndarray	Terugkeertijd norm voor de berekening (alleen voor semiprob).
h	float or np.ndarray	Buitenwaterstand [m+NAP].
h_exit	float or np.ndarray	Kwelslootpeil bij uitgang [m+NAP].
D	float or np.ndarray	Dikte watervoerende laag [m].
D_cover	float or np.ndarray	Dikte deklaag [m].
D_vl	float or np.ndarray	Dikte deklaag voorland [m].
D_al	float or np.ndarray	Dikte deklaag achterland [m].
k	float or np.ndarray	Doorlatendheid deklaag [m/s].
k_vl	float or np.ndarray	Doorlatendheid voorland [m/s].
k_al	float or np.ndarray	Doorlatendheid achterland [m/s].
cv_vl	float or np.ndarray	consolidatiecoëfficiënt klei voorland [m^2/s].
cv_al	float or np.ndarray	consolidatiecoëfficiënt klei achterland [m^2/s].
b	float or np.ndarray	b-waarde in TRWD model 4D (halve breedte rivierbed) [m]
n_aq	float or np.ndarray	Porositeit van de aquifer [-].
L	float or np.ndarray	Kwelweglengte [m].
L_vl	float or np.ndarray	Lengte voorland [m].
L_al	float or np.ndarray	Lengte achterland [m].
gamma_sat	float or np.ndarray	Verzadigd gewicht deklaag, gewogen gemiddelde voor meerdere lagen. [kN/m^3].
r_exit	float or np.ndarray	Dempingsfactor bij uitgang (dempingsfactor over de afstand intredepunt-uittredepunt) [-].
m_u	float or np.ndarray	Modelfactor uplift [-].
i_ch	float or np.ndarray	Kritieke heavegradiënt [-].
d_70	float or np.ndarray	70% kwantiel korrelgrootte van pipinggevoelige zandlaag [m].
eta	float or np.ndarray	White’s weerstandscoefficient (sleepkrachtfactor, constante van White) [-].
theta	float or np.ndarray	Rolweerstandshoek [graden].
d_70m	float or np.ndarray	Gemiddelde waarde korrelgrootte van 70e kwantiel [m].
g	float or np.ndarray	Zwaartekrachtversnelling [kN/m^3].
gamma_water	float or np.ndarray	Dichtheid water (volumiek gewicht water) [kN/m^3].
r_c	float or np.ndarray	Reductiefactor [-].
v	float or np.ndarray	Kinematische viscositeit [m^2/s]
gamma_sp	float or np.ndarray	Volumieke dichtheid zand onder water [kN/m^3]
krit_verval_factor	float or np.ndarray	Vermenigvuldigingsfactor voor kritiek verval, by default 1.0.
m_p	float or np.ndarray	Modelfactor piping [-].
methode_stijghoogte	str	Stijghoogte methode, by default “responsfactor”

Methods

Name	Description
copy	Create a copy of the current PipingSettings object.
get_partial_settings	Get a partial settings object for the i-th slice.
get_settings_as_dict	Get the settings as a dictionary.
set_param	Set a single parameter.
set_params_fromdict	Set parameters from a dictionary.
verify_integrity	Verify the integrity of the parameters by ensuring they are numpy arrays and have consistent sizes.

copy

PipingSettings.copy(verify_integrity=True)

Create a copy of the current PipingSettings object.

Parameters

Name	Type	Description	Default
verify_integrity	bool	Whether to verify the integrity of the parameters after copying, by default True.	True

Returns

Name	Type	Description
	PipingSettings	A new instance of PipingSettings with copied parameters.

get_partial_settings

PipingSettings.get_partial_settings(i, verify_integrity=True)

Get a partial settings object for the i-th slice.

Parameters

Name	Type	Description	Default
i	int	The index of the slice to extract.	required
verify_integrity	bool	Whether to verify the integrity of the parameters after extraction, by default True.	True

Returns

Name	Type	Description
	PipingSettings	A new instance of PipingSettings with the i-th slice of parameters.

get_settings_as_dict

PipingSettings.get_settings_as_dict()

Get the settings as a dictionary.

Returns

Name	Type	Description
	dict	A dictionary containing the parameter names and their values.

set_param

PipingSettings.set_param(attr, val, verify_integrity=True)

Set a single parameter.

Parameters

Name	Type	Description	Default
attr	str	The name of the attribute to set.	required
val	float or np.ndarray	The value to set for the attribute.	required
verify_integrity	bool	Whether to verify the integrity of the parameters after setting them, by default True.	True

Raises

Name	Type	Description
	ValueError	If the attribute name is unknown.

set_params_fromdict

PipingSettings.set_params_fromdict(piping_dict, verify_integrity=True)

Set parameters from a dictionary.

Parameters

Name	Type	Description	Default
piping_dict	dict	Dictionary containing parameter names and their values.	required
verify_integrity	bool	Whether to verify the integrity of the parameters after setting them, by default True.	True

verify_integrity

PipingSettings.verify_integrity()

Verify the integrity of the parameters by ensuring they are numpy arrays and have consistent sizes.

Raises

Name	Type	Description
	ValueError	If any parameter has more than one dimension.