Salome HOME
Enhance doc on parallelism.
[tools/medcoupling.git] / src / MEDCoupling / MEDCouplingFieldTemplate.hxx
1 // Copyright (C) 2007-2015  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 (CEA/DEN)
20
21 #ifndef __PARAMEDMEM_MEDCOUPLINGFIELDTEMPLATE_HXX__
22 #define __PARAMEDMEM_MEDCOUPLINGFIELDTEMPLATE_HXX__
23
24 #include "MEDCouplingField.hxx"
25
26 namespace ParaMEDMEM
27 {
28   class MEDCouplingFieldDouble;
29   /*!
30    * \brief A field template can be seen as a field without the array of values.
31    *
32    * A field template aggregates a MEDCouplingMesh and a spatial discretization object (instance of
33    * MEDCouplingFieldDiscretization).
34    * 
35    * MEDCouplingFieldTemplate is the most appropriate type for the preparation of matrix using
36    * MEDCouplingRemapper::prepareEx, since it contains the minimal information requireds to prepare
37    * the interpolation matrix.
38    */
39   class MEDCouplingFieldTemplate : public MEDCouplingField
40   {
41   public:
42     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *New(const MEDCouplingFieldDouble& f);
43     MEDCOUPLING_EXPORT static MEDCouplingFieldTemplate *New(TypeOfField type);
44     MEDCOUPLING_EXPORT std::string simpleRepr() const;
45     MEDCOUPLING_EXPORT std::string advancedRepr() const;
46     MEDCOUPLING_EXPORT void checkCoherency() const;
47     //
48     MEDCOUPLING_EXPORT void getTinySerializationIntInformation(std::vector<int>& tinyInfo) const;
49     MEDCOUPLING_EXPORT void getTinySerializationDbleInformation(std::vector<double>& tinyInfo) const;
50     MEDCOUPLING_EXPORT void getTinySerializationStrInformation(std::vector<std::string>& tinyInfo) const;
51     MEDCOUPLING_EXPORT void resizeForUnserialization(const std::vector<int>& tinyInfoI, DataArrayInt *&dataInt);
52     MEDCOUPLING_EXPORT void finishUnserialization(const std::vector<int>& tinyInfoI, const std::vector<double>& tinyInfoD, const std::vector<std::string>& tinyInfoS);
53     MEDCOUPLING_EXPORT void serialize(DataArrayInt *&dataInt) const;
54     //
55     MEDCOUPLING_EXPORT void reprQuickOverview(std::ostream& stream) const;
56   private:
57     MEDCouplingFieldTemplate(const MEDCouplingFieldDouble& f);
58     MEDCouplingFieldTemplate(TypeOfField type);
59   };
60 }
61
62 #endif