From: Jean-Philippe ARGAUD Date: Sun, 25 Oct 2020 06:43:50 +0000 (+0100) Subject: Documentation simple correction X-Git-Tag: V9_7_0b1~82 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=3ba3b02e3088b48721cd95fed83c14770bb6637e;p=modules%2Fadao.git Documentation simple correction --- diff --git a/doc/en/advanced.rst b/doc/en/advanced.rst index 5650fee..1baf223 100644 --- a/doc/en/advanced.rst +++ b/doc/en/advanced.rst @@ -430,23 +430,26 @@ Accelerating numerical derivatives calculations by using a parallel mode When setting an operator, as described in :ref:`section_ref_operator_requirements`, the user can choose a functional form -"*ScriptWithOneFunction*". This form explicitly leads to approximate the tangent -and adjoint operators by a finite differences calculation. It requires several -calls to the direct operator (user defined function), at least as many times as -the dimension of the state vector. This are these calls that can potentially be -executed in parallel. - -Under some conditions, it is then possible to accelerate the numerical -derivatives calculations by using a parallel mode for the finite differences -approximation. When setting up an ADAO case, it is done by adding the optional -keyword "*EnableMultiProcessing*", set to "1", for the "*SCRIPTWITHONEFUNCTION*" -command in the operator definition. The parallel mode will only use local -resources (both multi-cores or multi-processors) of the computer on which SALOME -is running, requiring as many resources as available. If necessary, one can -reduce the available ressources by limiting the possible number of parallel -processes using the keyword "*NumberOfProcesses*", set to desired maximum (or to -"0" for automatic control, which is the default value). By default, this -parallel mode is disabled ("*EnableMultiProcessing=0*"). +"*ScriptWithOneFunction*". This form explicitly leads to approximate the +tangent and adjoint operators (if they are required) by a finite differences +calculation. It requires several calls to the direct operator (which is the +user defined function), at least as many times as the dimension of the state +vector. This are these calls that can potentially be executed in parallel. + +Under some conditions (described right after), it is then possible to +accelerate the numerical derivatives calculations by using a parallel mode for +the finite differences approximation. When setting up an ADAO case, it is done +by adding the optional keyword "*EnableMultiProcessing*", set to "1" or +"*True*". This keyword is included in the "*SCRIPTWITHONEFUNCTION*" command in +the operator definition by graphical interface, or in the "*Parameters*" +accompanying the command "*OneFunction*" by textual interaface. By default, +this parallel mode is disabled ("*EnableMultiProcessing=0*"). The parallel mode +will only use local resources (both multi-cores or multi-processors) of the +computer on which execution is running, requiring by default as many resources +as available. If necessary, one can reduce the available ressources by limiting +the possible number of parallel processes using the keyword +"*NumberOfProcesses*", set to desired maximum number (or to "0" for automatic +control, which is the default value). The main conditions to perform parallel calculations come from the user defined function, that represents the direct operator. This function has at least to be diff --git a/doc/fr/advanced.rst b/doc/fr/advanced.rst index d6ba88c..dbae5f5 100644 --- a/doc/fr/advanced.rst +++ b/doc/fr/advanced.rst @@ -455,24 +455,28 @@ Accélérer les calculs de dérivées numériques en utilisant un mode parallèl Lors de la définition d'un opérateur, comme décrit dans le chapitre des :ref:`section_ref_operator_requirements`, l'utilisateur peut choisir la forme fonctionnelle "*ScriptWithOneFunction*". Cette forme conduit explicitement à -approximer les opérateurs tangent et adjoint par un calcul par différences -finies. Il requiert de nombreux appels à l'opérateur direct (fonction définie -par l'utilisateur), au moins autant de fois que la dimension du vecteur d'état. -Ce sont ces appels qui peuvent être potentiellement exécutés en parallèle. - -Sous certaines conditions, il est alors possible d'accélérer les calculs de -dérivées numériques en utilisant un mode parallèle pour l'approximation par -différences finies. Lors de la définition d'un cas ADAO, c'est effectué en -ajoutant le mot-clé optionnel "*EnableMultiProcessing*", mis à "1", de la -commande "*SCRIPTWITHONEFUNCTION*" dans la définition de l'opérateur. Le mode -parallèle utilise uniquement des ressources locales (à la fois multi-coeurs ou -multi-processeurs) de l'ordinateur sur lequel SALOME est en train de tourner, -demandant autant de ressources que disponible. Si nécessaire, on peut réduire -les ressources disponibles en limitant le nombre possible de processus -parallèles grâce au mot-clé optionnel "*NumberOfProcesses*", que l'on met au -maximum souhaité (ou à "0" pour le contrôle automatique, qui est la valeur par -défaut). Par défaut, ce mode parallèle est désactivé -("*EnableMultiProcessing=0*"). +approximer les opérateurs tangent et adjoint (s'ils sont nécessaires) par un +calcul par différences finies. Cela requiert de nombreux appels à l'opérateur +direct (qui est la fonction définie par l'utilisateur), au moins autant de fois +que la dimension du vecteur d'état. Ce sont ces appels qui peuvent être +potentiellement exécutés en parallèle. + +Sous certaines conditions (décrites juste après), il est possible d'accélérer +les calculs de dérivées numériques en utilisant un mode parallèle pour +l'approximation par différences finies. Lors de la définition d'un cas ADAO, +c'est effectué en ajoutant le mot-clé optionnel "*EnableMultiProcessing*", mis +à "*1*" ou à "*True*". Ce mot-clé est inclus à la commande +"*SCRIPTWITHONEFUNCTION*" dans la définition de l'opérateur par interface +graphique, ou aux "*Parameters*" accompagnant la commande "*OneFunction*" par +interface textuelle. Par défaut, ce mode parallèle est désactivé +("*EnableMultiProcessing=0*"). Le mode parallèle utilise uniquement des +ressources locales (à la fois multi-coeurs ou multi-processeurs) de +l'ordinateur sur lequel l'exécution est en train de se dérouler, demandant par +défaut autant de ressources que disponible. Si nécessaire, on peut réduire les +ressources disponibles en limitant le nombre possible de processus parallèles +grâce au mot-clé optionnel "*NumberOfProcesses*", que l'on met au nombre +maximal souhaité (ou à "*0*" pour le contrôle automatique, qui est la valeur +par défaut). Les principales conditions pour réaliser ces calculs parallèles viennent de la fonction définie par l'utilisateur, qui représente l'opérateur direct. Cette