doc/developer/doxygen/fakesources/MEDCouplingField.C

   1 // Copyright (C) 2013-2019  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // This file contains some code used only for
  21 // generation of documentation for inline methods.
  22
  23
  24 namespace MEDCoupling
  25 {
  26   /*!
  27    * Checks if \a this field is correctly defined, else an exception is thrown.
  28    *  \throw If the mesh is not set.
  29    *  \throw If the data array is not set.
  30    *  \throw If the spatial discretization of \a this field is NULL.
  31    *  \throw If \a this->getTimeTolerance() < 0.
  32    *  \throw If the temporal discretization data is incorrect.
  33    *  \throw If mesh data does not correspond to field data.
  34    */
  35   void MEDCouplingField::checkCoherency() const throw(INTERP_KERNEL::Exception) {}
  36   /*!
  37    * Returns the underlying mesh of \a this field.
  38    *  \return const MEDCoupling::MEDCouplingMesh * - a const pointer to the underlying mesh.
  39    */
  40   const MEDCoupling::MEDCouplingMesh *MEDCouplingField::getMesh() const {}
  41   /*!
  42    * Returns the description of \a this field.
  43    *  \return const char * - a string containing the field description.
  44    */
  45   const char *MEDCouplingField::getDescription() const {}
  46   /*!
  47    * Sets the description of \a this field.
  48    *  \param [in] desc - a string containing the field description.
  49    */
  50   void MEDCouplingField::setDescription(const char *desc) {}
  51   /*!
  52    * Returns the name of \a this field.
  53    *  \return const char * - a string containing the field name.
  54    */
  55   const char *MEDCouplingField::getName() const {}
  56 }