Salome HOME
Documentation minor corrections and improvements
[modules/adao.git] / doc / en / ref_algorithm_ParticleSwarmOptimization.rst
1 ..
2    Copyright (C) 2008-2014 EDF R&D
3
4    This file is part of SALOME ADAO module.
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    This library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with this library; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19
20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21
22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
23
24 .. index:: single: ParticleSwarmOptimization
25 .. _section_ref_algorithm_ParticleSwarmOptimization:
26
27 Calculation algorithm "*ParticleSwarmOptimization*"
28 ---------------------------------------------------
29
30 Description
31 +++++++++++
32
33 This algorithm realizes an estimation of the state of a dynamic system by a
34 particle swarm.
35
36 This is an optimization method allowing for global minimum search of a general
37 function of type :math:`L^1`, :math:`L^2` or :math:`L^{\infty}`, with or without
38 weights.
39
40 Optional and required commands
41 ++++++++++++++++++++++++++++++
42
43 .. index:: single: Background
44 .. index:: single: BackgroundError
45 .. index:: single: Observation
46 .. index:: single: ObservationError
47 .. index:: single: ObservationOperator
48 .. index:: single: MaximumNumberOfSteps
49 .. index:: single: NumberOfInsects
50 .. index:: single: SwarmVelocity
51 .. index:: single: GroupRecallRate
52 .. index:: single: QualityCriterion
53 .. index:: single: BoxBounds
54 .. index:: single: SetSeed
55 .. index:: single: StoreInternalVariables
56 .. index:: single: StoreSupplementaryCalculations
57
58 The general required commands, available in the editing user interface, are the
59 following:
60
61   Background
62     *Required command*. This indicates the background or initial vector used,
63     previously noted as :math:`\mathbf{x}^b`. Its value is defined as a
64     "*Vector*" or a *VectorSerie*" type object.
65
66   BackgroundError
67     *Required command*. This indicates the background error covariance matrix,
68     previously noted as :math:`\mathbf{B}`. Its value is defined as a "*Matrix*"
69     type object, a "*ScalarSparseMatrix*" type object, or a
70     "*DiagonalSparseMatrix*" type object.
71
72   Observation
73     *Required command*. This indicates the observation vector used for data
74     assimilation or optimization, previously noted as :math:`\mathbf{y}^o`. It
75     is defined as a "*Vector*" or a *VectorSerie* type object.
76
77   ObservationError
78     *Required command*. This indicates the observation error covariance matrix,
79     previously noted as :math:`\mathbf{R}`. It is defined as a "*Matrix*" type
80     object, a "*ScalarSparseMatrix*" type object, or a "*DiagonalSparseMatrix*"
81     type object.
82
83   ObservationOperator
84     *Required command*. This indicates the observation operator, previously
85     noted :math:`H`, which transforms the input parameters :math:`\mathbf{x}` to
86     results :math:`\mathbf{y}` to be compared to observations
87     :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or
88     a "*Matrix*" type one. In the case of "*Function*" type, different
89     functional forms can be used, as described in the section
90     :ref:`section_ref_operator_requirements`. If there is some control :math:`U`
91     included in the observation, the operator has to be applied to a pair
92     :math:`(X,U)`.
93
94 The general optional commands, available in the editing user interface, are
95 indicated in :ref:`section_ref_assimilation_keywords`. In particular, the
96 optional command "*AlgorithmParameters*" allows to choose the specific options,
97 described hereafter, of the algorithm. See
98 :ref:`section_ref_options_AlgorithmParameters` for the good use of this command.
99
100 The options of the algorithm are the following:
101
102   MaximumNumberOfSteps
103     This key indicates the maximum number of iterations allowed for iterative
104     optimization. The default is 50, which is an arbitrary limit. It is then
105     recommended to adapt this parameter to the needs on real problems.
106
107   NumberOfInsects
108     This key indicates the number of insects or particles in the swarm. The
109     default is 100, which is a usual default for this algorithm.
110
111   SwarmVelocity
112     This key indicates the part of the insect velocity which is imposed by the 
113     swarm. It is a positive floating point value. The default value is 1.
114
115   GroupRecallRate
116     This key indicates the recall rate at the best swarm insect. It is a
117     floating point value between 0 and 1. The default value is 0.5.
118
119   QualityCriterion
120     This key indicates the quality criterion, minimized to find the optimal
121     state estimate. The default is the usual data assimilation criterion named
122     "DA", the augmented weighted least squares. The possible criteria has to be
123     in the following list, where the equivalent names are indicated by the sign
124     "=": ["AugmentedWeightedLeastSquares"="AWLS"="DA",
125     "WeightedLeastSquares"="WLS", "LeastSquares"="LS"="L2",
126     "AbsoluteValue"="L1", "MaximumError"="ME"]
127   
128   BoxBounds
129     This key allows to define upper and lower bounds for *increments* on every
130     state variable being optimized (and not on state variables themselves).
131     Bounds have to be given by a list of list of pairs of lower/upper bounds for
132     each increment on variable, with extreme values every time there is no bound
133     (``None`` is not allowed when there is no bound). This key is required and
134     there is no default values.
135
136   SetSeed
137     This key allow to give an integer in order to fix the seed of the random
138     generator used to generate the ensemble. A convenient value is for example
139     1000. By default, the seed is left uninitialized, and so use the default
140     initialization from the computer.
141
142   StoreInternalVariables
143     This Boolean key allows to store default internal variables, mainly the
144     current state during iterative optimization process. Be careful, this can be
145     a numerically costly choice in certain calculation cases. The default is
146     "False".
147
148   StoreSupplementaryCalculations
149     This list indicates the names of the supplementary variables that can be
150     available at the end of the algorithm. It involves potentially costly
151     calculations or memory consumptions. The default is a void list, none of
152     these variables being calculated and stored by default. The possible names
153     are in the following list: ["BMA", "OMA", "OMB", "Innovation"].
154
155 See also
156 ++++++++
157
158 References to other sections:
159   - [WikipediaPSO]_