Salome HOME
remove src/MEDCalc/doc
[modules/med.git] / src / MEDCoupling / MEDCouplingMultiFields.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_MEDCOUPLINGMULTIFIELDS_HXX__
22 #define __PARAMEDMEM_MEDCOUPLINGMULTIFIELDS_HXX__
23
24 #include "MEDCouplingRefCountObject.hxx"
25 #include "MEDCouplingTimeLabel.hxx"
26 #include "MEDCouplingAutoRefCountObjectPtr.hxx"
27
28 #include "InterpKernelException.hxx"
29
30 #include <vector>
31
32 namespace ParaMEDMEM
33 {
34   class MEDCouplingMesh;
35   class DataArrayDouble;
36   class MEDCouplingFieldDouble;
37   class MEDCouplingFieldTemplate;
38
39   class MEDCouplingMultiFields : public RefCountObject, public TimeLabel
40   {
41   public:
42     MEDCOUPLING_EXPORT static MEDCouplingMultiFields *New(const std::vector<MEDCouplingFieldDouble *>& fs);
43     MEDCOUPLING_EXPORT static MEDCouplingMultiFields *New();
44     MEDCOUPLING_EXPORT MEDCouplingMultiFields *deepCpy() const;
45     MEDCOUPLING_EXPORT std::string getName() const;
46     MEDCOUPLING_EXPORT std::string getDescription() const;
47     MEDCOUPLING_EXPORT std::string getTimeUnit() const;
48     MEDCOUPLING_EXPORT double getTimeResolution() const;
49     MEDCOUPLING_EXPORT virtual std::string simpleRepr() const;
50     MEDCOUPLING_EXPORT virtual std::string advancedRepr() const;
51     MEDCOUPLING_EXPORT virtual bool isEqual(const MEDCouplingMultiFields *other, double meshPrec, double valsPrec) const;
52     MEDCOUPLING_EXPORT virtual bool isEqualWithoutConsideringStr(const MEDCouplingMultiFields *other, double meshPrec, double valsPrec) const;
53     MEDCOUPLING_EXPORT const MEDCouplingFieldDouble *getFieldWithId(int id) const;
54     MEDCOUPLING_EXPORT std::vector<const MEDCouplingFieldDouble *> getFields() const;
55     MEDCOUPLING_EXPORT int getNumberOfFields() const;
56     MEDCOUPLING_EXPORT const MEDCouplingFieldDouble *getFieldAtPos(int id) const;
57     MEDCOUPLING_EXPORT virtual std::vector<MEDCouplingMesh *> getMeshes() const;
58     MEDCOUPLING_EXPORT virtual std::vector<MEDCouplingMesh *> getDifferentMeshes(std::vector<int>& refs) const;
59     MEDCOUPLING_EXPORT virtual std::vector<DataArrayDouble *> getArrays() const;
60     MEDCOUPLING_EXPORT virtual std::vector<DataArrayDouble *> getDifferentArrays(std::vector< std::vector<int> >& refs) const;
61     MEDCOUPLING_EXPORT void updateTime() const;
62     MEDCOUPLING_EXPORT std::size_t getHeapMemorySizeWithoutChildren() const;
63     MEDCOUPLING_EXPORT std::vector<const BigMemoryObject *> getDirectChildrenWithNull() const;
64     MEDCOUPLING_EXPORT void getTinySerializationInformation(std::vector<int>& tinyInfo, std::vector<double>& tinyInfo2, int& nbOfDiffMeshes, int& nbOfDiffArr) const;
65     MEDCOUPLING_EXPORT void finishUnserialization(const std::vector<int>& tinyInfoI, const std::vector<double>& tinyInfoD,
66                                                   const std::vector<MEDCouplingFieldTemplate *>& ft, const std::vector<MEDCouplingMesh *>& ms,
67                                                   const std::vector<DataArrayDouble *>& das);
68     MEDCOUPLING_EXPORT virtual void checkCoherency() const;
69   protected:
70     MEDCOUPLING_EXPORT MEDCouplingMultiFields(const std::vector<MEDCouplingFieldDouble *>& fs);
71     MEDCOUPLING_EXPORT MEDCouplingMultiFields(const MEDCouplingMultiFields& other);
72     MEDCOUPLING_EXPORT MEDCouplingMultiFields();
73   protected:
74     std::vector< MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> > _fs;
75   };
76 }
77
78 #endif
79