Référence de la classe cCourbeRemous

Graphe de collaboration de cCourbeRemous:

Fonctions membres publiques
	__construct (&$oLog, &$oParam, &$oSect, $rDx)
	Calc_Y ($rY, $sResolution)
	Calc_Y_Trapez_Fn ()
	calcul ($rYCL, $rLong, $sResolution)

Attributs publics
	$oP
	$oSect
	$VarCal
const	DBG = false

Fonctions membres privées
	Calc_dYdX ($Y)
	Calc_Y_Euler ($Y)
	Calc_Y_RK4 ($Y)
	Calc_Y_Trapez ($Y)

Attributs privés
	$oLog
	$rDx

Description détaillée

Calcul d'une courbe de remous.

Définition à la ligne 24 du fichier hyd_inc/courbe_remous.php.

Documentation des constructeurs et destructeur

__construct()

cCourbeRemous::__construct	(	&	$oLog,
		&	$oParam,
		&	$oSect,
			$rDx
	)

Variable calculée Y pour la dichotomie (intégration trapèze)

Construction de la classe.

Paramètres

$oLog	Journal de calcul
$objet	Objet contenant la méthode de calcul du débit et la propriété VarCal pointeur vers la variable à calculer
$sFnCalculQ	Nom de la méthode de calcul du débit

Définition à la ligne 44 du fichier hyd_inc/courbe_remous.php.

Références $oLog, $oSect, et $rDx.

Documentation des fonctions membres

Calc_dYdX()

cCourbeRemous::Calc_dYdX (   $Y )

private

Calcul de dy/dx.

Définition à la ligne 55 du fichier hyd_inc/courbe_remous.php.

Référencé par Calc_Y_Euler(), et Calc_Y_RK4().

Voici le graphe des appelants de cette fonction :

Calc_Y()

cCourbeRemous::Calc_Y	(		$rY,
			$sResolution
	)

Calcul du point suivant d'une courbe de remous.

Paramètres

$rY	Tirant d'eau initial

Renvoie

Tirant d'eau

Définition à la ligne 134 du fichier hyd_inc/courbe_remous.php.

Référencé par calcul().

Voici le graphe des appelants de cette fonction :

Calc_Y_Euler()

cCourbeRemous::Calc_Y_Euler (   $Y )

private

Calcul du point suivant de la courbe de remous par la méthode Euler explicite.

Paramètres

$rY	Tirant d'eau initial

Renvoie

Tirant d'eau

Définition à la ligne 66 du fichier hyd_inc/courbe_remous.php.

Références Calc_dYdX().

Voici le graphe d'appel pour cette fonction :

Calc_Y_RK4()

cCourbeRemous::Calc_Y_RK4 (   $Y )

private

Calcul du point suivant de la courbe de remous par la méthode RK4.

Paramètres

$rY	Tirant d'eau initial

Renvoie

Tirant d'eau

Définition à la ligne 82 du fichier hyd_inc/courbe_remous.php.

Références $rDx, et Calc_dYdX().

Voici le graphe d'appel pour cette fonction :

Calc_Y_Trapez()

cCourbeRemous::Calc_Y_Trapez (   $Y )

private

Calcul du point suivant de la courbe de remous par la méthode de l'intégration par trapèze.

Paramètres

$rY	Tirant d'eau initial

Renvoie

Tirant d'eau

Définition à la ligne 111 du fichier hyd_inc/courbe_remous.php.

Références $rDx.

Calc_Y_Trapez_Fn()

cCourbeRemous::Calc_Y_Trapez_Fn

(

)

Equation de l'intégration par la méthode des trapèzes.

Définition à la ligne 101 du fichier hyd_inc/courbe_remous.php.

Références $rDx.

calcul()

cCourbeRemous::calcul	(		$rYCL,
			$rLong,
			$sResolution
	)

Calcul d'une courbe de remous en fluvia ou torrentiel.

Paramètres

$rYCL	Condition limite amont (torrentiel) ou aval (fluvial)
$rLong	Longueur du bief à calculer
$sResolution	Méthode numérique Euler, RK4 ou Trapez

Définition à la ligne 149 du fichier hyd_inc/courbe_remous.php.

Références $rDx, et Calc_Y().

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

$oLog

cCourbeRemous::$oLog

private

Section du bief.

Définition à la ligne 30 du fichier hyd_inc/courbe_remous.php.

Référencé par __construct().

$oP

cCourbeRemous::$oP

Pour loguer les messages de debug de cette classe.

Définition à la ligne 28 du fichier hyd_inc/courbe_remous.php.

$oSect

cCourbeRemous::$oSect

Paramètres de la section.

Définition à la ligne 29 du fichier hyd_inc/courbe_remous.php.

Référencé par __construct().

$rDx

cCourbeRemous::$rDx

private

Journal de calcul.

Définition à la ligne 32 du fichier hyd_inc/courbe_remous.php.

Référencé par __construct(), Calc_Y_RK4(), Calc_Y_Trapez(), Calc_Y_Trapez_Fn(), et calcul().

$VarCal

cCourbeRemous::$VarCal

Pas d'espace (positif en partant de l'aval, négatif en partant de l'amont)

Définition à la ligne 34 du fichier hyd_inc/courbe_remous.php.

DBG

const cCourbeRemous::DBG = false

Définition à la ligne 26 du fichier hyd_inc/courbe_remous.php.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• hyd_inc/courbe_remous.php