doc/en/ref_algorithm_InputValuesTest.rst

   1 ..
   2    Copyright (C) 2008-2024 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: InputValuesTest
  25 .. _section_ref_algorithm_InputValuesTest:
  26
  27 Checking algorithm "*InputValuesTest*"
  28 --------------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  33 This algorithm verifies the content of the current input variables and the way
  34 the data is interpreted or read during its acquisition, through the display of
  35 size information and statistics on the inputs. It also allows to display the
  36 whole content of the variables read in printed form for verification (*warning,
  37 if a variable is large in size, this can be difficult*).
  38
  39 .. ------------------------------------ ..
  40 .. include:: snippets/Header2Algo12.rst
  41
  42 .. include:: snippets/FeaturePropDerivativeFree.rst
  43
  44 .. ------------------------------------ ..
  45 .. include:: snippets/Header2Algo02.rst
  46
  47 .. include:: snippets/Background.rst
  48
  49 .. include:: snippets/CheckingPoint.rst
  50
  51 .. include:: snippets/Observation.rst
  52
  53 *Tips for this algorithm:*
  54
  55     Because *"ObservationOperator"*, in the graphical interface, is a required
  56     command for ALL checking algorithms, you have to provide a value for it,
  57     despite the fact that this command is not required for this test, and will
  58     not be used. The easiest way is to give "1" as a STRING,
  59     *"ObservationOperator"* having to be of type sparse *Matrix*.
  60
  61 .. ------------------------------------ ..
  62 .. include:: snippets/Header2Algo03Chck.rst
  63
  64 .. include:: snippets/NumberOfPrintedDigits.rst
  65
  66 .. include:: snippets/PrintAllValuesFor.rst
  67
  68 .. include:: snippets/ShowInformationOnlyFor.rst
  69
  70 .. include:: snippets/SetDebug.rst
  71
  72 .. ------------------------------------ ..
  73 .. _section_ref_algorithm_InputValuesTest_examples:
  74
  75 .. include:: snippets/Header2Algo06.rst
  76
  77 - :ref:`section_ref_algorithm_ControledFunctionTest`
  78 - :ref:`section_ref_algorithm_FunctionTest`
  79 - :ref:`section_ref_algorithm_ParallelFunctionTest`