Référence de la classe cOuvrage

Graphe de collaboration de cOuvrage:

Fonctions membres publiques
	__construct (&$oLog, $tP)
	Calc ($sCalc, $rInit=0.)
	OuvrageQ ()
	Set ($sMaj, $rMaj)

Attributs publics
	$VarCal
const	G = 9.81
const	R2G = 4.42944
const	R32 = 2.59807

Fonctions membres privées
	CalculQ ($nLoi, $rC, $rZ=0)
	SeuilDen ($rC, $rZ=0)
	SeuilNoy ($rC, $rZ=0)
	VanneDen ($rC)
	VanneNoy ($rC)

Attributs privés
	$nL
	$nLS
	$oLog
	$tP = array()

Description détaillée

Calculs sur un ouvrage.

Définition à la ligne 34 du fichier ouvrage.class.php.

Documentation des constructeurs et destructeur

__construct()

cOuvrage::__construct	(	&	$oLog,
			$tP
	)

3*sqrt(3)/2;

Construction de la classe. Calcul des ouvrages

Paramètres

$oLog	Objet gérant le journal de calcul
$nLoi	Loi de débit à l'ouvrage
$tP	Tableaux des caractéristiques à l'ouvrage (largeur...)
$nLoiSurverse	Loi de débit de la surverse

Définition à la ligne 92 du fichier ouvrage.class.php.

Références $oLog, et $tP.

Documentation des fonctions membres

Calc()

cOuvrage::Calc	(		$sCalc,
			$rInit = 0.
	)

Calcul à l'ouvrage.

Paramètres

$sCalc	Variable à calculer (indice du tableau tP)
$rInit	Valeur initiale pour le calcul

Renvoie

array(0=> donnée calculée, 1=> Flag d'écoulement) Signification du Flag d'écoulement :

• -1 : erreur de calcul
• 0 : débit nul
• 1 : surface libre dénoyé
• 2 : surface libre noyé
• 3 : charge denoyé
• 4 : charge noyé partiel
• 5 : charge noyé total
• 11 : surverse dénoyé
• 12 : surverse noyé

Définition à la ligne 136 du fichier ouvrage.class.php.

Références OuvrageQ().

Voici le graphe d'appel pour cette fonction :

CalculQ()

cOuvrage::CalculQ (   $nLoi,   $rC,   $rZ = 0  )

private

Calcul du débit à partir d'une loi.

Paramètres

$nLoi	Loi de débit
$rC	Coefficient de débit
$rZ	Cote de radier à retrancher pour la surverse

Renvoie

array(0=> débit, 1=> Flag d'écoulement) (Voir Calc)

Définition à la ligne 281 du fichier ouvrage.class.php.

Références $tP, SeuilDen(), SeuilNoy(), VanneDen(), et VanneNoy().

Référencé par OuvrageQ().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

OuvrageQ()

cOuvrage::OuvrageQ

(

)

Calcul du débit à l'ouvrage.

Renvoie

array(0=> débit, 1=> Flag d'écoulement) (Voir Calc)

Définition à la ligne 154 du fichier ouvrage.class.php.

Références CalculQ().

Référencé par Calc().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Set()

cOuvrage::Set	(		$sMaj,
			$rMaj
	)

Mise à jour d'un paramètre de l'ouvrage.

Paramètres

$sMaj	Variable à modifier (indice du tableau tP)
$rmaj	Valeur de la variable à mettre à jour

Définition à la ligne 114 du fichier ouvrage.class.php.

SeuilDen()

cOuvrage::SeuilDen (   $rC,   $rZ = 0  )

private

Loi seuil dénoyé classique.

Paramètres

$rC	Coefficient de débit
$rZ	Cote de radier à retrancher pour la surverse

Renvoie

array(0=> débit, 1=> Flag d'écoulement) (Voir Calc)

Définition à la ligne 257 du fichier ouvrage.class.php.

Référencé par CalculQ().

Voici le graphe des appelants de cette fonction :

SeuilNoy()

cOuvrage::SeuilNoy (   $rC,   $rZ = 0  )

private

Loi seuil noyé classique.

Paramètres

$rC	Coefficient de débit
$rZ	Cote de radier à retrancher pour la surverse

Renvoie

array(0=> débit, 1=> Flag d'écoulement) (Voir Calc)

Définition à la ligne 269 du fichier ouvrage.class.php.

Référencé par CalculQ().

Voici le graphe des appelants de cette fonction :

VanneDen()

cOuvrage::VanneDen (   $rC )

private

Loi de vanne de fond dénoyée classique.

Paramètres

$rC	Coefficient de débit

Renvoie

array(0=> débit, 1=> Flag d'écoulement) (Voir Calc)

Définition à la ligne 214 du fichier ouvrage.class.php.

Référencé par CalculQ().

Voici le graphe des appelants de cette fonction :

VanneNoy()

cOuvrage::VanneNoy (   $rC )

private

Loi de vanne de fond totalement noyée classique.

Paramètres

$rC	Coefficient de débit

Renvoie

array(0=> débit, 1=> Flag d'écoulement) (Voir Calc)

Définition à la ligne 235 du fichier ouvrage.class.php.

Référencé par CalculQ().

Voici le graphe des appelants de cette fonction :

Documentation des données membres

$nL

cOuvrage::$nL

private

Journal des calculs.

Loi de débit pour l'ouvrage. Valeurs possibles :

• 1 - Déversoir/Orifice Cemagref 88 : Type 1,2,3 + Surverse
• 2 - Vanne de fond/Seuil Cemagref 88 : Type 1,2,3 + Surverse
• 3 - Seuil dénoyé : Type 3 + Surverse
• 4 - Seuil noyé : Type 3 + Surverse
• 5 - Vanne dénoyé : Type 1,2
• 6 - Vanne noyé : Type 1,2
• 7 - Cunge 1980 : Type 1,2,3 + Surverse
• 8 - Déversoir/Orifice Cemagref 02 : Type 4,5
• 9 - Vanne de fond/Seuil Cemagref 02 : Type 4,5

Définition à la ligne 48 du fichier ouvrage.class.php.

$nLS

cOuvrage::$nLS

private

Loi de débit pour la surverse.

Valeurs possibles :

• 1 - Déversoir/Orifice Cemagref 88
• 2 - Vanne de fond/Seuil Cemagref 88
• 3 - Seuil dénoyé
• 4 - Seuil noyé
• 7 - Cunge 1980

Définition à la ligne 57 du fichier ouvrage.class.php.

$oLog

cOuvrage::$oLog

private

Définition à la ligne 35 du fichier ouvrage.class.php.

Référencé par __construct().

$tP

cOuvrage::$tP = array()

private

Tableau contenant les paramètres de l'ouvrage.

Liste des clés possibles du tableau :

• Q : le débit de l'ouvrage
• ZM : la cote de l'eau à l'amont par rapport au radier
• ZV : la cote de l'eau à l'aval par rapport au radier
• L : largeur
• Z : cote de radier
• W : ouverture de vanne
• A : Angle des ouvrages triangulaires
• H : Hauteur de la vanne pour la surverse
• C : Coefficient de débit pour tous types sauf trapézoïdal
• CR : Coefficient de débit partie rectangulaire pour les trapézoïdales
• CT : Coefficient de débit partie triangulaire pour les trapézoïdales
• CS : Coefficient de débit de la surverse
• rPrec : Précision du calcul

Définition à la ligne 76 du fichier ouvrage.class.php.

Référencé par __construct(), et CalculQ().

$VarCal

cOuvrage::$VarCal

Pointeur vers l'élément du tableau tP qui sera calculé

Définition à la ligne 78 du fichier ouvrage.class.php.

G

const cOuvrage::G = 9.81

Définition à la ligne 80 du fichier ouvrage.class.php.

R2G

const cOuvrage::R2G = 4.42944

Constante de gravité terrestre.

Définition à la ligne 81 du fichier ouvrage.class.php.

R32

const cOuvrage::R32 = 2.59807

sqrt(2*self::gP);

Définition à la ligne 82 du fichier ouvrage.class.php.

---

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

• ouvrage.class.php