doc/doxygen/doxfiles/functionalities.dox

   1 /*!
   2 \page functionalities Available functionalities
   3
   4
   5 \section directOperations Direct operations on fields
   6 \subsection directOperations_creation Field creation
   7 - From scratch: \b New
   8
   9 - Copy: \b clone*, \b deepCpy
  10
  11 \subsection directOperations_modification Partial modifications
  12 - Creation: \b New, \b setMesh, \b setArray* \n
  13   \if ENABLE_EXAMPLES
  14   Example 1: \ref medcouplingpyexamplesFieldDoubleBuild1 \n
  15   Example 2: \ref medcouplingpyexamplesFieldDoubleBuild2 \n
  16   Example 3: \ref medcouplingpyexamplesFieldDoubleBuild3 \n
  17   Example 4: \ref medcouplingpyexamplesFieldDoubleBuild4 \n
  18   \endif
  19 - Copy
  20   - \b buildNewTimeReprFromThis
  21   \if ENABLE_EXAMPLES
  22   .
  23   Example: \ref py_mcfielddouble_buildNewTimeReprFromThis
  24   \endif
  25 - Subparts
  26   - \b buildSubPart*
  27   \if ENABLE_EXAMPLES
  28   .
  29   Example: \ref py_mcfielddouble_subpart1
  30   \endif
  31   - \b keepSelectedComponents, \b setSelectedComponents
  32
  33 And also:
  34
  35 - Description: \b setName
  36
  37 - I/O: cf. MEDLoader
  38
  39
  40 \section arithmeticOperations Local arithmetic
  41 \subsection arithmeticOperations_scalar Operations on scalars
  42 - Affectation
  43   - From a constant: \b =
  44   - From an expression: \b applyFunc* \b applyLin \b fillFromAnalytic* \n
  45   \if ENABLE_EXAMPLES
  46     Example 1: \ref py_mcfielddouble_applyFunc_same_nb_comp \n
  47     Example 2: \ref py_mcfielddouble_applyFunc3 \n
  48     Example 3: \ref py_mcfielddouble_applyFunc2 \n
  49     Example 4: \ref py_mcfielddouble_applyFunc \n
  50     Example 5: \ref py_mcmesh_fillFromAnalytic3 \n
  51     Example 6: \ref py_mcmesh_fillFromAnalytic2 \n
  52     Example 7: \ref py_mcmesh_fillFromAnalytic \n
  53     Example 8: \ref cpp_mcfielddouble_fillFromAnalytic_c_func \n
  54     Example 9: \ref cpp_mcfielddouble_applyFunc_c_func
  55   \endif
  56 - Addition
  57   - \b + \b += \b AddFields
  58   \if ENABLE_EXAMPLES
  59   .
  60   Example: \ref medcouplingpyexamplesFieldDoubleBuild5
  61   \endif
  62 - Subtraction
  63   - \b \- \b \-= \b SubstractFields
  64   - \b substractInPlaceDM
  65   \if ENABLE_EXAMPLES
  66   .
  67   Example: \ref py_mcfielddouble_substractInPlaceDM
  68   \endif
  69 - Multiplication
  70   - \b * \b *= \b MultiplyFields
  71   \if ENABLE_EXAMPLES
  72   .
  73   Example: \ref medcouplingpyexamplesFieldDoubleBuild5
  74   \endif
  75 - Division:
  76   - \b / \b /= \b DivideFields
  77   \if ENABLE_EXAMPLES
  78   .
  79   Example: \ref medcouplingpyexamplesFieldDoubleBuild5
  80   \endif
  81 - Power: \b ^ \b ^= \b PowFields
  82
  83 \subsection arithmeticOperations_vector Operations on vectors or second order tensors
  84 - Contracted product: \b doublyContractedProduct
  85 - Determinant: \b determinant
  86 - Eigenvalues and eigenvectors: \b eigenValues, \b eigenVectors
  87 - Tensor inversion: \b inverse
  88 - Trace: \b trace
  89 - Deviator: \b deviator
  90 - Norms: \b norm*
  91
  92
  93 \section interpolationOperations Interpolation
  94
  95
  96 \section globalOperations Global operations
  97 - Spatial extrema: \b MaxFields, \b MinFields \n
  98   \if ENABLE_EXAMPLES
  99   Example: \ref py_mcfielddouble_MaxFields
 100   \endif
 101 - Spatial mean: \b getAverageValue
 102
 103 - Temporal extrema
 104   - \b getMaxValue*
 105   - \b getMinValue*
 106
 107
 108 \section otherOperations Others
 109 - Renumbering a mesh: \b renumber* \n
 110   \if ENABLE_EXAMPLES
 111   Example 1: \ref py_mcfielddouble_renumberNodes \n
 112   Example 2: \ref py_mcfielddouble_renumberCells
 113   \endif
 114 - Merge non overlapping fields: \b MergeFields \n
 115   \if ENABLE_EXAMPLES
 116   Example: \ref py_mcfielddouble_MergeFields
 117   \endif
 118 */