From 6fbcf0b0fb9626499c372345a4ab2ed6eb34e1b3 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Sun, 12 May 2019 11:09:47 +0200 Subject: [PATCH] Minor documentation corrections --- doc/en/glossary.rst | 44 ++++++++++++++++++++++--- doc/en/ref_observers_requirements.rst | 6 ++-- doc/fr/glossary.rst | 46 ++++++++++++++++++++++++--- doc/fr/ref_observers_requirements.rst | 6 ++-- doc/fr/theory.rst | 4 +-- src/daComposant/daCore/Templates.py | 4 +-- 6 files changed, 91 insertions(+), 19 deletions(-) diff --git a/doc/en/glossary.rst b/doc/en/glossary.rst index 545c20d..61ee03a 100644 --- a/doc/en/glossary.rst +++ b/doc/en/glossary.rst @@ -44,6 +44,40 @@ Glossary through the "*YACS Container Log*" window, which is updated during the process, and using "*Observers*" attached to calculation variables. + physical system + This is the object of study that will be represented by numerical + simulation and observed by measurements. + + digital simulator + All the numerical relationships and equations characterizing the physical + system studied. + + numerical simulation + Computational implementation of the set composed of the numerical + simulator and a particular set of all the input and control variables of + the simulator. These variables enable the digital simulator to be able to + numerically represent the system's behaviour. + + observations or measurements + These are quantities that come from measuring instruments and + characterize the physical system to be studied. These quantities can vary + in space or time, can be punctual or integrated. They are themselves + characterized by their measurement nature, size, etc. + + observation operator + It is a transformation of the simulated state into a set of quantities + explicitly comparable to the observations. + + boundary conditions + These are particular input and control variables of the simulator, which + characterize the description of the system's behaviour at the border of + the simulation spatial domain. + + initial conditions + These are specific simulator input and control variables that + characterize the description of the system's behavior at the initial edge + of the simulation time domain. + APosterioriCovariance Keyword to indicate the covariance matrix of *a posteriori* analysis errors. @@ -93,12 +127,14 @@ Glossary to 1, a "good" estimation leading to a parameter "close" to 1. analysis - The optimal state estimation through a data assimilation or optimization - procedure. + It is the optimal state estimated through a data assimilation or + optimization procedure. background - The *a priori* known state, which is not optimal, and is used as a rough - estimate, or a "best estimate", before an optimal estimation. + It is a part (chosen to be modified) of the system state representation, + representation known *a priori* or initial one, which is not optimal, and + which is used as a rough estimate, or a "best estimate", before an + optimal estimation. innovation Difference between the observations and the result of the simulation based diff --git a/doc/en/ref_observers_requirements.rst b/doc/en/ref_observers_requirements.rst index 7db4be2..a900f38 100644 --- a/doc/en/ref_observers_requirements.rst +++ b/doc/en/ref_observers_requirements.rst @@ -438,7 +438,7 @@ Print on standard output the L2 norm of the current value of the variable. :: import numpy - v = numpy.matrix( numpy.ravel( var[-1] ) ) + v = numpy.ravel( var[-1] ) print(str(info)+" "+str(float( numpy.linalg.norm(v) ))) .. index:: single: ValueRMS (Observer) @@ -451,5 +451,5 @@ Print on standard output the root mean square (RMS), or quadratic mean, of the c :: import numpy - v = numpy.matrix( numpy.ravel( var[-1] ) ) - print(str(info)+" "+str(float( numpy.sqrt((1./v.size)*(v*v.T)) ))) + v = numpy.ravel( var[-1] ) + print(str(info)+" "+str(float( numpy.sqrt((1./v.size)*numpy.dot(v,v)) ))) diff --git a/doc/fr/glossary.rst b/doc/fr/glossary.rst index 12ef475..fcecff8 100644 --- a/doc/fr/glossary.rst +++ b/doc/fr/glossary.rst @@ -47,6 +47,41 @@ Glossaire jour au fur et à mesure du déroulement du calcul, et en utilisant des "*Observers*" attachés à des variables de calcul. + système physique + C'est l'objet d'étude que l'on va représenter par simulation numérique, + et que l'on observe par des mesures. + + simulateur numérique + Ensemble des relations numériques et des équations caractérisant le + système physique étudié. + + simulation numérique + Mise en oeuvre calculatoire de l'ensemble constitué du simulateur + numérique et d'un jeu particulier de toutes les variables d'entrée et de + contrôle du simulateur. Ces variables permettent de mettre le simulateur + numérique en capacité de représenter numériquement le comportement du + système. + + observations ou mesures + Ce sont des quantités qui proviennent d'instruments de mesures et qui + caractérisent le système physique à étudier. Ces quantités peuvent varier + en espace ou en temps, peuvent être ponctuelles ou intégrées. Elles sont + elles-mêmes caractérisées par leur nature de mesure, leur dimension, etc. + + opérateur d'observation + C'est une transformation de l'état simulé en un ensemble de quantités + explicitement comparables aux observations. + + conditions aux limites + Ce sont des variables particulières d'entrée et de contrôle du + simulateur, qui caractérisent la description du comportement du système + en bordure du domaine spatial de simulation. + + conditions initiales + Ce sont des variables particulières d'entrée et de contrôle du + simulateur, qui caractérisent la description du comportement du système + en bordure initiale du domaine temporel de simulation. + APosterioriCovariance Mot-clé indiquant la matrice de covariance des erreurs *a posteriori* d'analyse. @@ -96,16 +131,17 @@ Glossaire "proche" de 1. analyse - L'état optimal estimé par une procédure d'assimilation de données ou - d'optimisation. + C'est l'état optimal de représentation du système estimé par une + procédure d'assimilation de données ou d'optimisation. background C'est le terme anglais pour désigner l'ébauche. ébauche - C'est l'état du système connu *a priori*, qui n'est pas optimal, et qui - est utilisé comme une estimation grossière, ou "la meilleure connue", - avant une estimation optimale. + C'est une part (choisie pour être modifiable) de la représentation de + l'état du système, représentation connue *a priori* ou initiale, qui + n'est pas optimale, et qui est utilisée comme une estimation grossière ou + comme "la meilleure connue", avant une estimation optimale. innovation Différence entre les observations et le résultat de la simulation basée diff --git a/doc/fr/ref_observers_requirements.rst b/doc/fr/ref_observers_requirements.rst index 3610580..eaad88e 100644 --- a/doc/fr/ref_observers_requirements.rst +++ b/doc/fr/ref_observers_requirements.rst @@ -441,7 +441,7 @@ Imprime sur la sortie standard la norme L2 de la valeur courante de la variable. :: import numpy - v = numpy.matrix( numpy.ravel( var[-1] ) ) + v = numpy.ravel( var[-1] ) print(str(info)+" "+str(float( numpy.linalg.norm(v) ))) .. index:: single: ValueRMS (Observer) @@ -454,5 +454,5 @@ Imprime sur la sortie standard la racine de la moyenne des carrés (RMS), ou moy :: import numpy - v = numpy.matrix( numpy.ravel( var[-1] ) ) - print(str(info)+" "+str(float( numpy.sqrt((1./v.size)*(v*v.T)) ))) + v = numpy.ravel( var[-1] ) + print(str(info)+" "+str(float( numpy.sqrt((1./v.size)*numpy.dot(v,v)) ))) diff --git a/doc/fr/theory.rst b/doc/fr/theory.rst index c932431..b6a6016 100644 --- a/doc/fr/theory.rst +++ b/doc/fr/theory.rst @@ -75,8 +75,8 @@ Reconstruction de champs ou interpolation de données .. index:: single: interpolation de champs La **reconstruction (ou l'interpolation) de champs** consiste à trouver, à -partir d'un nombre restreint de mesures réelles, le champs physique qui est le -plus *cohérent* avec ces mesures. +partir d'un nombre restreint de mesures réelles, le (ou les) champ(s) +physique(s) qui est (sont) le(s) plus *cohérent(s)* avec ces mesures. La *cohérence* est à comprendre en termes d'interpolation, c'est-à-dire que le champ que l'on cherche à reconstruire, en utilisant de l'assimilation de données diff --git a/src/daComposant/daCore/Templates.py b/src/daComposant/daCore/Templates.py index 4f7c606..1d1880d 100644 --- a/src/daComposant/daCore/Templates.py +++ b/src/daComposant/daCore/Templates.py @@ -212,14 +212,14 @@ ObserverTemplates.store( ) ObserverTemplates.store( name = "ValueL2Norm", - content = """import numpy\nv = numpy.matrix( numpy.ravel( var[-1] ) )\nprint(str(info)+" "+str(float( numpy.linalg.norm(v) )))""", + content = """import numpy\nv = numpy.ravel( var[-1] )\nprint(str(info)+" "+str(float( numpy.linalg.norm(v) )))""", fr_FR = "Imprime sur la sortie standard la norme L2 de la valeur courante de la variable", en_EN = "Print on standard output the L2 norm of the current value of the variable", order = "next", ) ObserverTemplates.store( name = "ValueRMS", - content = """import numpy\nv = numpy.matrix( numpy.ravel( var[-1] ) )\nprint(str(info)+" "+str(float( numpy.sqrt((1./v.size)*(v*v.T)) )))""", + content = """import numpy\nv = numpy.ravel( var[-1] )\nprint(str(info)+" "+str(float( numpy.sqrt((1./v.size)*numpy.dot(v,v)) )))""", fr_FR = "Imprime sur la sortie standard la racine de la moyenne des carrés (RMS), ou moyenne quadratique, de la valeur courante de la variable", en_EN = "Print on standard output the root mean square (RMS), or quadratic mean, of the current value of the variable", order = "next", -- 2.39.2