2 Copyright (C) 2008-2023 EDF R&D
4 This file is part of SALOME ADAO module.
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.
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.
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
20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
24 .. index:: single: ParticleSwarmOptimization
25 .. _section_ref_algorithm_ParticleSwarmOptimization:
27 Calculation algorithm "*ParticleSwarmOptimization*"
28 ---------------------------------------------------
30 .. ------------------------------------ ..
31 .. include:: snippets/Header2Algo01.rst
33 This algorithm realizes an estimation of the state of a system by minimization
34 of a cost function :math:`J` by using an evolutionary strategy of particle
35 swarm. It is a method that does not use the derivatives of the cost function.
36 It falls in the same category than the
37 :ref:`section_ref_algorithm_DerivativeFreeOptimization`, the
38 :ref:`section_ref_algorithm_DifferentialEvolution` or the
39 :ref:`section_ref_algorithm_TabuSearch`.
41 This is an optimization method allowing for global minimum search of a general
42 error function :math:`J` of type :math:`L^1`, :math:`L^2` or :math:`L^{\infty}`,
43 with or without weights. The default error function is the augmented weighted
44 least squares function, classically used in data assimilation.
46 .. ------------------------------------ ..
47 .. include:: snippets/Header2Algo02.rst
49 .. include:: snippets/Background.rst
51 .. include:: snippets/BackgroundError.rst
53 .. include:: snippets/Observation.rst
55 .. include:: snippets/ObservationError.rst
57 .. include:: snippets/ObservationOperator.rst
59 .. ------------------------------------ ..
60 .. include:: snippets/Header2Algo03AdOp.rst
62 .. include:: snippets/MaximumNumberOfIterations_50.rst
64 .. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
66 .. include:: snippets/QualityCriterion.rst
68 .. include:: snippets/NumberOfInsects.rst
70 .. include:: snippets/SwarmVelocity.rst
72 .. include:: snippets/GroupRecallRate.rst
74 .. include:: snippets/BoxBounds.rst
76 .. include:: snippets/SetSeed.rst
78 StoreSupplementaryCalculations
79 .. index:: single: StoreSupplementaryCalculations
81 *List of names*. This list indicates the names of the supplementary
82 variables, that can be available during or at the end of the algorithm, if
83 they are initially required by the user. Their avalability involves,
84 potentially, costly calculations or memory consumptions. The default is then
85 a void list, none of these variables being calculated and stored by default
86 (excepted the unconditionnal variables). The possible names are in the
87 following list (the detailed description of each named variable is given in
88 the following part of this specific algorithmic documentation, in the
89 sub-section "*Information and variables available at the end of the
96 "CurrentIterationNumber",
101 "SimulatedObservationAtBackground",
102 "SimulatedObservationAtCurrentState",
103 "SimulatedObservationAtOptimum",
107 ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
109 .. ------------------------------------ ..
110 .. include:: snippets/Header2Algo04.rst
112 .. include:: snippets/Analysis.rst
114 .. include:: snippets/CostFunctionJ.rst
116 .. include:: snippets/CostFunctionJb.rst
118 .. include:: snippets/CostFunctionJo.rst
120 .. ------------------------------------ ..
121 .. include:: snippets/Header2Algo05.rst
123 .. include:: snippets/Analysis.rst
125 .. include:: snippets/BMA.rst
127 .. include:: snippets/CostFunctionJ.rst
129 .. include:: snippets/CostFunctionJb.rst
131 .. include:: snippets/CostFunctionJo.rst
133 .. include:: snippets/CurrentIterationNumber.rst
135 .. include:: snippets/CurrentState.rst
137 .. include:: snippets/Innovation.rst
139 .. include:: snippets/OMA.rst
141 .. include:: snippets/OMB.rst
143 .. include:: snippets/SimulatedObservationAtBackground.rst
145 .. include:: snippets/SimulatedObservationAtCurrentState.rst
147 .. include:: snippets/SimulatedObservationAtOptimum.rst
149 .. ------------------------------------ ..
150 .. _section_ref_algorithm_ParticleSwarmOptimization_examples:
152 .. include:: snippets/Header2Algo06.rst
154 - :ref:`section_ref_algorithm_DerivativeFreeOptimization`
155 - :ref:`section_ref_algorithm_DifferentialEvolution`
156 - :ref:`section_ref_algorithm_TabuSearch`
158 .. ------------------------------------ ..
159 .. include:: snippets/Header2Algo07.rst