Salome HOME
3361fd906e58014a4e7cb1f3fa5a9f42509d0b33
[tools/medcoupling.git] / src / MEDCoupling / MEDCouplingFieldTemplate.hxx
1 // Copyright (C) 2007-2020  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 #pragma once
22
23 #include "MEDCouplingField.hxx"
24
25 namespace MEDCoupling
26 {
27   class MEDCouplingFieldInt32;
28   class MEDCouplingFieldInt64;
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 MEDCouplingFieldInt32& f);
47     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *New(const MEDCouplingFieldInt64& f);
48     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *New(TypeOfField type);
49     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *NewWithoutCheck(const MEDCouplingFieldDouble& f);
50     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *NewWithoutCheck(const MEDCouplingFieldFloat& f);
51     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *NewWithoutCheck(const MEDCouplingFieldInt32& f);
52     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *NewWithoutCheck(const MEDCouplingFieldInt64& f);
53     MEDCOUPLING_EXPORT std::string getClassName() const override { return std::string("MEDCouplingFieldTemplate"); }
54     MEDCOUPLING_EXPORT bool isEqualIfNotWhy(const MEDCouplingFieldTemplate *other, double meshPrec, std::string& reason) const;
55     MEDCOUPLING_EXPORT bool isEqual(const MEDCouplingFieldTemplate *other, double meshPrec) const;
56     MEDCOUPLING_EXPORT bool isEqualWithoutConsideringStr(const MEDCouplingFieldTemplate *other, double meshPrec) const;
57     MEDCOUPLING_EXPORT std::string simpleRepr() const;
58     MEDCOUPLING_EXPORT std::string advancedRepr() const;
59     MEDCOUPLING_EXPORT void checkConsistencyLight() const;
60     MEDCOUPLING_EXPORT MCAuto<MEDCouplingFieldTemplate> clone(bool recDeepCpy) const;
61     //
62     MEDCOUPLING_EXPORT void getTinySerializationIntInformation(std::vector<mcIdType>& tinyInfo) const;
63     MEDCOUPLING_EXPORT void getTinySerializationDbleInformation(std::vector<double>& tinyInfo) const;
64     MEDCOUPLING_EXPORT void getTinySerializationStrInformation(std::vector<std::string>& tinyInfo) const;
65     MEDCOUPLING_EXPORT void resizeForUnserialization(const std::vector<mcIdType>& tinyInfoI, DataArrayIdType *&dataInt);
66     MEDCOUPLING_EXPORT void finishUnserialization(const std::vector<mcIdType>& tinyInfoI, const std::vector<double>& tinyInfoD, const std::vector<std::string>& tinyInfoS);
67     MEDCOUPLING_EXPORT void serialize(DataArrayIdType *&dataInt) const;
68     //
69     MEDCOUPLING_EXPORT void reprQuickOverview(std::ostream& stream) const;
70   private:
71     MEDCouplingFieldTemplate(const MEDCouplingFieldDouble& f, bool isChecked=true);
72     MEDCouplingFieldTemplate(const MEDCouplingFieldFloat& f, bool isChecked=true);
73     MEDCouplingFieldTemplate(const MEDCouplingFieldInt32& f, bool isChecked=true);
74     MEDCouplingFieldTemplate(const MEDCouplingFieldInt64& f, bool isChecked=true);
75     MEDCouplingFieldTemplate(TypeOfField type);
76     MEDCouplingFieldTemplate(const MEDCouplingFieldTemplate& other, bool deepCopy);
77   };
78 }