doc/user/doxygen/doxfiles/start/functionalities.dox

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