.. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/AmplitudeOfTangentPerturbation.rst
+
.. include:: snippets/EpsilonMinimumExponent.rst
.. include:: snippets/InitialDirection.rst
-.. include:: snippets/SetSeed.rst
-
-ResiduFormula
- .. index:: single: ResiduFormula
+.. include:: snippets/ResiduFormula_GradientTest.rst
- *Predefined name*. This key indicates the residue formula that has to be
- used for the test. The default choice is "Taylor", and the possible ones are
- "Taylor" (normalized residue of the Taylor development of the operator, which
- has to decrease with the square power of the perturbation), "TaylorOnNorm"
- (residue of the Taylor development of the operator with respect to the
- perturbation to the square, which has to remain constant) and "Norm" (residue
- obtained by taking the norm of the Taylor development at zero order
- approximation, which approximate the gradient, and which has to remain
- constant).
-
- Example :
- ``{"ResiduFormula":"Taylor"}``
+.. include:: snippets/SetSeed.rst
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
.. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/AmplitudeOfTangentPerturbation.rst
+
.. include:: snippets/EpsilonMinimumExponent.rst
.. include:: snippets/InitialDirection.rst
-.. include:: snippets/SetSeed.rst
-
-ResiduFormula
- .. index:: single: ResiduFormula
+.. include:: snippets/ResiduFormula_LinearityTest.rst
- *Predefined name*. This key indicates the residue formula that has to be
- used for the test. The default choice is "CenteredDL", and the possible ones
- are "CenteredDL" (residue of the difference between the function at nominal
- point and the values with positive and negative increments, which has to stay
- very small), "Taylor" (residue of the Taylor development of the operator
- normalized by the nominal value, which has to stay very small),
- "NominalTaylor" (residue of the order 1 approximations of the operator,
- normalized to the nominal point, which has to stay close to 1), and
- "NominalTaylorRMS" (residue of the order 1 approximations of the operator,
- normalized by RMS to the nominal point, which has to stay close to 0).
-
- Example :
- ``{"ResiduFormula":"CenteredDL"}``
+.. include:: snippets/SetSeed.rst
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
.. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/AmplitudeOfTangentPerturbation.rst
+
.. include:: snippets/EpsilonMinimumExponent.rst
.. include:: snippets/InitialDirection.rst
--- /dev/null
+.. index:: single: AmplitudeOfTangentPerturbation
+
+AmplitudeOfTangentPerturbation
+ *Real value*. This key indicates the relative numerical magnitude of the
+ perturbation used to estimate the tangent value of the operator at the
+ evaluation point, i.e. its directional derivative. The conservative default
+ is 1.e-2, and it is strongly recommended to adapt it to the needs of real
+ problems, by decreasing its value by several orders of magnitude.
+
+ Example :
+ ``{"AmplitudeOfTangentPerturbation":1.e-2}``
--- /dev/null
+.. index:: single: ResiduFormula
+
+ResiduFormula
+ *Predefined name*. This key indicates the residue formula that has to be
+ used for the test. The default choice is "Taylor", and the possible ones are
+ "Taylor" (normalized residue of the Taylor development of the operator, which
+ has to decrease with the square power of the perturbation), "TaylorOnNorm"
+ (residue of the Taylor development of the operator with respect to the
+ perturbation to the square, which has to remain constant) and "Norm" (residue
+ obtained by taking the norm of the Taylor development at zero order
+ approximation, which approximate the gradient, and which has to remain
+ constant).
+
+ Example :
+ ``{"ResiduFormula":"Taylor"}``
--- /dev/null
+.. index:: single: ResiduFormula
+
+ResiduFormula
+ *Predefined name*. This key indicates the residue formula that has to be
+ used for the test. The default choice is "CenteredDL", and the possible ones
+ are "CenteredDL" (residue of the difference between the function at nominal
+ point and the values with positive and negative increments, which has to stay
+ very small), "Taylor" (residue of the Taylor development of the operator
+ normalized by the nominal value, which has to stay very small),
+ "NominalTaylor" (residue of the order 1 approximations of the operator,
+ normalized to the nominal point, which has to stay close to 1), and
+ "NominalTaylorRMS" (residue of the order 1 approximations of the operator,
+ normalized by RMS to the nominal point, which has to stay close to 0).
+
+ Example :
+ ``{"ResiduFormula":"CenteredDL"}``
.. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/AmplitudeOfTangentPerturbation.rst
+
.. include:: snippets/EpsilonMinimumExponent.rst
.. include:: snippets/InitialDirection.rst
-.. include:: snippets/SetSeed.rst
-
-ResiduFormula
- .. index:: single: ResiduFormula
+.. include:: snippets/ResiduFormula_GradientTest.rst
- *Nom prédéfini*. Cette clé indique la formule de résidu qui doit être
- utilisée pour le test. Le choix par défaut est "Taylor", et les choix
- possibles sont "Taylor" (résidu du développement de Taylor normalisé de
- l'opérateur, qui doit décroître comme le carré de la perturbation),
- "TaylorOnNorm" (résidu du développement de Taylor rapporté à la perturbation
- de l'opérateur, qui doit rester constant) et "Norm" (résidu obtenu en prenant
- la norme du développement de Taylor à l'ordre 0, qui approxime le gradient,
- et qui doit rester constant).
-
- Exemple :
- ``{"ResiduFormula":"Taylor"}``
+.. include:: snippets/SetSeed.rst
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
.. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/AmplitudeOfTangentPerturbation.rst
+
.. include:: snippets/EpsilonMinimumExponent.rst
.. include:: snippets/InitialDirection.rst
-.. include:: snippets/SetSeed.rst
-
-ResiduFormula
- .. index:: single: ResiduFormula
-
- *Nom prédéfini*. Cette clé indique la formule de résidu qui doit être
- utilisée pour le test. Le choix par défaut est "CenteredDL", et les choix
- possibles sont "CenteredDL" (résidu de la différence entre la fonction au
- point nominal et ses valeurs avec des incréments positif et négatif, qui doit
- rester très faible), "Taylor" (résidu du développement de Taylor de
- l'opérateur normalisé par sa valeur nominal, qui doit rester très faible),
- "NominalTaylor" (résidu de l'approximation à l'ordre 1 de l'opérateur,
- normalisé au point nominal, qui doit rester proche de 1), et
- "NominalTaylorRMS" (résidu de l'approximation à l'ordre 1 de l'opérateur,
- normalisé par l'écart quadratique moyen (RMS) au point nominal, qui doit
- rester proche de 0).
+.. include:: snippets/ResiduFormula_LinearityTest.rst
- Exemple :
- ``{"ResiduFormula":"CenteredDL"}``
+.. include:: snippets/SetSeed.rst
StoreSupplementaryCalculations
.. index:: single: StoreSupplementaryCalculations
.. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/AmplitudeOfTangentPerturbation.rst
+
.. include:: snippets/EpsilonMinimumExponent.rst
.. include:: snippets/InitialDirection.rst
--- /dev/null
+.. index:: single: AmplitudeOfTangentPerturbation
+
+AmplitudeOfTangentPerturbation
+ *Valeur réelle*. Cette clé indique l'amplitude numérique relative de la
+ perturbation utilisée pour estimer la valeur tangente de l'opérateur au point
+ d'évaluation, i.e. sa dérivée directionnelle. Le défaut conservatif est de
+ 1.e-2, et il est fortement recommandé de l'adapter aux besoins pour des
+ problèmes réels, en diminuant sa valeur de plusieurs ordres de grandeur.
+
+ Exemple :
+ ``{"AmplitudeOfTangentPerturbation":1.e-2}``
--- /dev/null
+.. index:: single: ResiduFormula
+
+ResiduFormula
+ *Nom prédéfini*. Cette clé indique la formule de résidu qui doit être
+ utilisée pour le test. Le choix par défaut est "Taylor", et les choix
+ possibles sont "Taylor" (résidu du développement de Taylor normalisé de
+ l'opérateur, qui doit décroître comme le carré de la perturbation),
+ "TaylorOnNorm" (résidu du développement de Taylor rapporté à la perturbation
+ de l'opérateur, qui doit rester constant) et "Norm" (résidu obtenu en prenant
+ la norme du développement de Taylor à l'ordre 0, qui approxime le gradient,
+ et qui doit rester constant).
+
+ Exemple :
+ ``{"ResiduFormula":"Taylor"}``
--- /dev/null
+.. index:: single: ResiduFormula
+
+ResiduFormula
+ *Nom prédéfini*. Cette clé indique la formule de résidu qui doit être
+ utilisée pour le test. Le choix par défaut est "CenteredDL", et les choix
+ possibles sont "CenteredDL" (résidu de la différence entre la fonction au
+ point nominal et ses valeurs avec des incréments positif et négatif, qui doit
+ rester très faible), "Taylor" (résidu du développement de Taylor de
+ l'opérateur normalisé par sa valeur nominal, qui doit rester très faible),
+ "NominalTaylor" (résidu de l'approximation à l'ordre 1 de l'opérateur,
+ normalisé au point nominal, qui doit rester proche de 1), et
+ "NominalTaylorRMS" (résidu de l'approximation à l'ordre 1 de l'opérateur,
+ normalisé par l'écart quadratique moyen (RMS) au point nominal, qui doit
+ rester proche de 0).
+
+ Exemple :
+ ``{"ResiduFormula":"CenteredDL"}``
