src/MEDCoupling/MEDCouplingFieldTemplate.hxx

   1 // Copyright (C) 2007-2019  CEA/DEN, EDF R&D
   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 // Author : Anthony Geay (EDF R&D)
  20
  21 #ifndef __PARAMEDMEM_MEDCOUPLINGFIELDTEMPLATE_HXX__
  22 #define __PARAMEDMEM_MEDCOUPLINGFIELDTEMPLATE_HXX__
  23
  24 #include "MEDCouplingField.hxx"
  25
  26 namespace MEDCoupling
  27 {
  28   class MEDCouplingFieldInt;
  29   class MEDCouplingFieldFloat;
  30   class MEDCouplingFieldDouble;
  31   /*!
  32    * \brief A field template can be seen as a field without the array of values.
  33    *
  34    * A field template aggregates a MEDCouplingMesh and a spatial discretization object (instance of
  35    * MEDCouplingFieldDiscretization).
  36    *
  37    * MEDCouplingFieldTemplate is the most appropriate type for the preparation of matrix using
  38    * MEDCouplingRemapper::prepareEx, since it contains the minimal information requireds to prepare
  39    * the interpolation matrix.
  40    */
  41   class MEDCouplingFieldTemplate : public MEDCouplingField
  42   {
  43   public:
  44     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *New(const MEDCouplingFieldDouble& f);
  45     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *New(const MEDCouplingFieldFloat& f);
  46     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *New(const MEDCouplingFieldInt& f);
  47     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *New(TypeOfField type);
  48     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *NewWithoutCheck(const MEDCouplingFieldDouble& f);
  49     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *NewWithoutCheck(const MEDCouplingFieldFloat& f);
  50     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *NewWithoutCheck(const MEDCouplingFieldInt& f);
  51     MEDCOUPLING_EXPORT std::string getClassName() const override { return std::string("MEDCouplingFieldTemplate"); }
  52     MEDCOUPLING_EXPORT bool isEqualIfNotWhy(const MEDCouplingFieldTemplate *other, double meshPrec, std::string& reason) const;
  53     MEDCOUPLING_EXPORT bool isEqual(const MEDCouplingFieldTemplate *other, double meshPrec) const;
  54     MEDCOUPLING_EXPORT bool isEqualWithoutConsideringStr(const MEDCouplingFieldTemplate *other, double meshPrec) const;
  55     MEDCOUPLING_EXPORT std::string simpleRepr() const;
  56     MEDCOUPLING_EXPORT std::string advancedRepr() const;
  57     MEDCOUPLING_EXPORT void checkConsistencyLight() const;
  58     MEDCOUPLING_EXPORT MCAuto<MEDCouplingFieldTemplate> clone(bool recDeepCpy) const;
  59     //
  60     MEDCOUPLING_EXPORT void getTinySerializationIntInformation(std::vector<mcIdType>& tinyInfo) const;
  61     MEDCOUPLING_EXPORT void getTinySerializationDbleInformation(std::vector<double>& tinyInfo) const;
  62     MEDCOUPLING_EXPORT void getTinySerializationStrInformation(std::vector<std::string>& tinyInfo) const;
  63     MEDCOUPLING_EXPORT void resizeForUnserialization(const std::vector<mcIdType>& tinyInfoI, DataArrayIdType *&dataInt);
  64     MEDCOUPLING_EXPORT void finishUnserialization(const std::vector<mcIdType>& tinyInfoI, const std::vector<double>& tinyInfoD, const std::vector<std::string>& tinyInfoS);
  65     MEDCOUPLING_EXPORT void serialize(DataArrayIdType *&dataInt) const;
  66     //
  67     MEDCOUPLING_EXPORT void reprQuickOverview(std::ostream& stream) const;
  68   private:
  69     MEDCouplingFieldTemplate(const MEDCouplingFieldDouble& f, bool isChecked=true);
  70     MEDCouplingFieldTemplate(const MEDCouplingFieldFloat& f, bool isChecked=true);
  71     MEDCouplingFieldTemplate(const MEDCouplingFieldInt& f, bool isChecked=true);
  72     MEDCouplingFieldTemplate(TypeOfField type);
  73     MEDCouplingFieldTemplate(const MEDCouplingFieldTemplate& other, bool deepCopy);
  74   };
  75 }
  76
  77 #endif