1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2% File      : InternalNames
3% Author    : th202608@pleiades068.intra.cea.fr
4% Date      : 28 févr. 2013
5% Directory : /home/th202608/codes/tfel/trunk/src/trunk/docs/mfront/
6%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7
8\section{Noms des variables et des méthodes \cpp{} utilisés en
9  interne par les analyseurs de lois de comportement}
10\label{sec:noms-des-variables}
11
12\subsection{Noms communs à tous les analyseurs de lois de
13  comportement}
14\label{sec:noms-communs-tous}
15
16Certain variables sont utilisées en interne et ne peuvent être
17utilisées par l'utilisateur.
18
19Certaines des variables ont des sens physiques~:
20\begin{itemize}
21\item \varcpp{D} désigne le tenseur d'élasticité. Ce tenseur est
22  calculé à la demande, voir à ce sujet la documentation de la
23  directive
24  \mkeyb{RequireStiffnessTensor}{Require\-Stiff\-ness\-Tensor}.
25\item \varcpp{Dt} désigne la matrice tangente, éventuellement
26  cohérente~;
27\item \varcpp{sig} désigne les contraintes~;
28\item \varcpp{F0} désigne le gradient de la transformation en début de
29  pas~;
30\item \varcpp{F1} désigne le gradient de la transformation en fin de
31  pas~;
32\item \varcpp{eto} désigne les déformations totales~;
33\item \varcpp{deto} désigne l'incrément des déformations totales ou
34  leurs vitesses ou sa vitesse (voir les conventions spécifiques de
35  chaque analyseur)~;
36\item \varcpp{T} est la température, généralement en début de pas
37  (voir les conventions spécifiques de chaque analyseur)~;
38\item \varcpp{dT} est l'incrément de la température ou sa vitesse de
39  variation (voir les conventions spécifiques de chaque analyseur)~;
40\item \varcpp{dt} est l'incrément de temps~;
41\item \varcpp{N} est la dimension spatiale associée à l'hypothèse de
42  modélisation considérée (\(1\), \(2\) ou \(3\))~;
43\end{itemize}
44
45Certaines noms sont utilisés en interne~:
46\begin{itemize}
47\item \varcpp{Type} est le nom du type numérique utilisé pour les
48  calculs~;
49\item \varcpp{use\textunderscore{}qt} est un booléen. Si il est vrai, les variables
50  utilisées sont affectées d'unités et la cohérence des calculs, au
51  sens du respect des unités, est assurée par le compilateur~;
52\item \varcpp{std}, \varcpp{tfel}, \varcpp{math}, \varcpp{material} et
53  \varcpp{utilities} qui désignent des espaces de noms des librairies
54  \cpp{} utilisées pour l'intégration des lois~;
55\item \varcpp{real} qui est un alias du type réel utilisé par la
56  routine d'intégration~;
57\item \varcpp{policy} et \varcpp{policy\textunderscore{}value} qui
58  déterminent la politique à suivre en cas de dépassement des bornes~;
59\item \varcpp{src1}, \varcpp{src2} sont des noms de variables utilisés
60  par les constructeurs des classes générés~;
61\item \varcpp{integrate} est le principal point d'entrée méthode
62  d'intégration~;
63 \item \varcpp{computeStress} qui recalcule la valeur du tenseur des
64   contraintes au cours de l'intégration~;
65 \item \varcpp{computeFinalStress} qui calcule la valeur du tenseur
66   des contraintes en fin de pas~;
67 \item \varcpp{computeFdF} qui calcule la valeur de la fonction à
68   annuler et de sa dérivée pour les méthodes implicites~;
69 \item \varcpp{updateStateVars} qui met à jour les valeurs des
70   variables d'état, après un pas d'intégration réussi~;
71 \item \varcpp{updateAuxiliaryStateVars} qui met à jour les valeurs
72   des variables d'état auxiliaires, après un pas d'intégration
73   réussi~;
74 \item \varcpp{getModellingHypothesis} qui permet de récupérer
75   l'actuelle hypothèse de modélisation~;
76 \item \varcpp{getTimeStepScalingFactor} qui retourne un estimation du
77   pas de temps à utiliser (pour le pas de temps courant ou pour le
78   pas de temps suivant~;
79 \item \varcpp{getTangentOperator} qui retourne la matrice tangente,
80   éventuellement cohérente, si celle-ci est disponible~;
81 \item \varcpp{hypothesis}, qui est une variable contenant l'hypothèse
82   de modélisation~;
83 \item \varcpp{hypothesis\textunderscore{}}, qui est utilisé dans les
84   constructeurs pour initialiser la valeur de la variable
85   \varcpp{hypothesis}.
86\end{itemize}
87
88\subsection{Noms de variables réservés par les analyseurs spécifiques}
89\label{sec:noms-de-variables}
90
91Les variables suivantes sont utilisées en interne par les analyseurs
92spécifiques et leurs noms ne peuvent être réutilisés par
93l'utilisateur~:
94\begin{itemize}
95\item \varcpp{NewtonIntegration} est le nom de la méthode réalisant
96  les itérations de la méthode de \nom{Newton}~;
97\item \varcpp{theta} est le nom du paramètre de la méthode implicite~;
98\item \varcpp{epsilon} est le nom de la valeur du critère utilisé pour
99  arrêter les itérations de la méthode de \nom{Newton}~;
100\item \varcpp{iterMax} est le nom du nombre d'itérations autorisées
101  pour la méthode de \nom{Newton}~;
102\item \varcpp{p} est la déformation inélastique cumulée est le nom de
103  la déformation plastique cumulée~;
104\item \varcpp{n} est le nom de la direction d'écoulement, donnée par
105  la normale aux isovaleurs de contrainte équivalente.
106\end{itemize}
107
108\subsection{Noms de variables réservés par l'analyseur \nom{Runge-Kutta}}
109
110\begin{itemize}
111\item \varcpp{epsilon}
112\item \varcpp{dtmin}
113\item \varcpp{eel}
114\item \varcpp{deel}
115\item \varcpp{t}
116\item \varcpp{T\textunderscore{}}
117\item \varcpp{eto\textunderscore{}}
118\item \varcpp{deto\textunderscore{}}
119\item \varcpp{dt\textunderscore{}}
120\item \varcpp{corrector}
121\item \varcpp{dtprec}
122\item \varcpp{converged}
123\item \varcpp{error}
124\item \varcpp{failed}
125\end{itemize}
126
127\subsection{Noms de variables réservés par l'analyseur implicite}
128
129\begin{itemize}
130  \item \varcpp{theta}
131  \item \varcpp{epsilon}
132  \item \varcpp{iterMax}
133  \item \varcpp{jacobianComparisonCriterium}
134  \item \varcpp{relaxationTrigger}
135  \item \varcpp{accelerationTrigger}
136  \item \varcpp{accelerationPeriod}
137  \item \varcpp{relaxationCoefficient}
138  \item \varcpp{eel}
139  \item \varcpp{deel}
140  \item \varcpp{previous\textunderscore{}zeros}
141  \item \varcpp{zeros}
142  \item \varcpp{tzeros}
143  \item \varcpp{zeros\textunderscore{}1}
144  \item \varcpp{fzeros}
145  \item \varcpp{tfzeros}
146  \item \varcpp{zeros2}
147  \item \varcpp{fzeros2}
148  \item \varcpp{Dzeros}
149  \item \varcpp{Dfzeros}
150  \item \varcpp{jacobian}
151  \item \varcpp{tjacobian}
152  \item \varcpp{njacobian}
153  \item \varcpp{jacobian2}
154  \item \varcpp{t}
155  \item \varcpp{dt\textunderscore{}}
156  \item \varcpp{error}
157  \item \varcpp{idx}
158  \item \varcpp{idx2}
159  \item \varcpp{schmidt}
160  \item \varcpp{computeNumericalJacobian}
161  \item \varcpp{accelerate}
162  \item \varcpp{accelerate\textunderscore{}k0}
163  \item \varcpp{accelerate\textunderscore{}k1}
164  \item \varcpp{accelerate\textunderscore{}k2}
165  \item \varcpp{accelerate\textunderscore{}c0}
166  \item \varcpp{accelerate\textunderscore{}c1}
167  \item \varcpp{accelerate\textunderscore{}re0}
168  \item \varcpp{accelerate\textunderscore{}re1}
169  \item \varcpp{accelerate\textunderscore{}r0}
170  \item \varcpp{accelerate\textunderscore{}r1}
171  \item \varcpp{accelerate\textunderscore{}r2}
172  \item \varcpp{iter}
173  \item \varcpp{converge}
174  \item \varcpp{broyden\textunderscore{}inv}
175\end{itemize}
176