src/MEDCoupling/MEDCouplingFieldDouble.hxx

   1 // Copyright (C) 2007-2012  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.
   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_MEDCOUPLINGFIELDDOUBLE_HXX__
  22 #define __PARAMEDMEM_MEDCOUPLINGFIELDDOUBLE_HXX__
  23
  24 #include "MEDCoupling.hxx"
  25 #include "MEDCouplingField.hxx"
  26 #include "MEDCouplingTimeDiscretization.hxx"
  27 #include "MEDCouplingMemArray.hxx"
  28
  29 namespace ParaMEDMEM
  30 {
  31   class MEDCouplingFieldTemplate;
  32
  33   class MEDCOUPLING_EXPORT MEDCouplingFieldDouble : public MEDCouplingField
  34   {
  35   public:
  36     static MEDCouplingFieldDouble *New(TypeOfField type, TypeOfTimeDiscretization td=ONE_TIME);
  37     static MEDCouplingFieldDouble *New(const MEDCouplingFieldTemplate& ft, TypeOfTimeDiscretization td=ONE_TIME);
  38     void setTimeUnit(const char *unit);
  39     const char *getTimeUnit() const;
  40     void synchronizeTimeWithSupport() throw(INTERP_KERNEL::Exception);
  41     void copyTinyStringsFrom(const MEDCouplingField *other) throw(INTERP_KERNEL::Exception);
  42     void copyTinyAttrFrom(const MEDCouplingFieldDouble *other) throw(INTERP_KERNEL::Exception);
  43     void copyAllTinyAttrFrom(const MEDCouplingFieldDouble *other) throw(INTERP_KERNEL::Exception);
  44     std::string simpleRepr() const;
  45     std::string advancedRepr() const;
  46     void writeVTK(const char *fileName) const throw(INTERP_KERNEL::Exception);
  47     bool isEqualIfNotWhy(const MEDCouplingField *other, double meshPrec, double valsPrec, std::string& reason) const throw(INTERP_KERNEL::Exception);
  48     bool isEqualWithoutConsideringStr(const MEDCouplingField *other, double meshPrec, double valsPrec) const;
  49     bool areCompatibleForMerge(const MEDCouplingField *other) const;
  50     bool areStrictlyCompatible(const MEDCouplingField *other) const;
  51     bool areCompatibleForMul(const MEDCouplingField *other) const;
  52     bool areCompatibleForDiv(const MEDCouplingField *other) const;
  53     bool areCompatibleForMeld(const MEDCouplingFieldDouble *other) const;
  54     void renumberCells(const int *old2NewBg, bool check=true) throw(INTERP_KERNEL::Exception);
  55     void renumberCellsWithoutMesh(const int *old2NewBg, bool check=true) throw(INTERP_KERNEL::Exception);
  56     void renumberNodes(const int *old2NewBg) throw(INTERP_KERNEL::Exception);
  57     void renumberNodesWithoutMesh(const int *old2NewBg, int newNbOfNodes, double eps=1e-15) throw(INTERP_KERNEL::Exception);
  58     DataArrayInt *getIdsInRange(double vmin, double vmax) const throw(INTERP_KERNEL::Exception);
  59     MEDCouplingFieldDouble *buildSubPart(const DataArrayInt *part) const throw(INTERP_KERNEL::Exception);
  60     MEDCouplingFieldDouble *buildSubPart(const int *partBg, const int *partEnd) const throw(INTERP_KERNEL::Exception);
  61     MEDCouplingFieldDouble *deepCpy() const;
  62     MEDCouplingFieldDouble *clone(bool recDeepCpy) const;
  63     MEDCouplingFieldDouble *cloneWithMesh(bool recDeepCpy) const;
  64     MEDCouplingFieldDouble *buildNewTimeReprFromThis(TypeOfTimeDiscretization td, bool deepCopy) const;
  65     TypeOfTimeDiscretization getTimeDiscretization() const;
  66     void checkCoherency() const throw(INTERP_KERNEL::Exception);
  67     void setNature(NatureOfField nat) throw(INTERP_KERNEL::Exception);
  68     void setTimeTolerance(double val) { _time_discr->setTimeTolerance(val); }
  69     double getTimeTolerance() const { return _time_discr->getTimeTolerance(); }
  70     void setIteration(int it) throw(INTERP_KERNEL::Exception) { _time_discr->setIteration(it); }
  71     void setEndIteration(int it) throw(INTERP_KERNEL::Exception) { _time_discr->setEndIteration(it); }
  72     void setOrder(int order) throw(INTERP_KERNEL::Exception) { _time_discr->setOrder(order); }
  73     void setEndOrder(int order) throw(INTERP_KERNEL::Exception) { _time_discr->setEndOrder(order); }
  74     void setTimeValue(double val) throw(INTERP_KERNEL::Exception) { _time_discr->setTimeValue(val); }
  75     void setEndTimeValue(double val) throw(INTERP_KERNEL::Exception) { _time_discr->setEndTimeValue(val); }
  76     void setTime(double val, int iteration, int order) { _time_discr->setTime(val,iteration,order); }
  77     void synchronizeTimeWithMesh() throw(INTERP_KERNEL::Exception);
  78     void setStartTime(double val, int iteration, int order) { _time_discr->setStartTime(val,iteration,order); }
  79     void setEndTime(double val, int iteration, int order) { _time_discr->setEndTime(val,iteration,order); }
  80     double getTime(int& iteration, int& order) const { return _time_discr->getTime(iteration,order); }
  81     double getStartTime(int& iteration, int& order) const { return _time_discr->getStartTime(iteration,order); }
  82     double getEndTime(int& iteration, int& order) const { return _time_discr->getEndTime(iteration,order); }
  83     double getIJ(int tupleId, int compoId) const { return getArray()->getIJ(tupleId,compoId); }
  84     double getIJK(int cellId, int nodeIdInCell, int compoId) const;
  85     void setArray(DataArrayDouble *array);
  86     void setEndArray(DataArrayDouble *array);
  87     void setArrays(const std::vector<DataArrayDouble *>& arrs) throw(INTERP_KERNEL::Exception);
  88     const DataArrayDouble *getArray() const { return _time_discr->getArray(); }
  89     DataArrayDouble *getArray() { return _time_discr->getArray(); }
  90     const DataArrayDouble *getEndArray() const { return _time_discr->getEndArray(); }
  91     DataArrayDouble *getEndArray() { return _time_discr->getEndArray(); }
  92     std::vector<DataArrayDouble *> getArrays() const { std::vector<DataArrayDouble *> ret; _time_discr->getArrays(ret); return ret; }
  93     double accumulate(int compId) const;
  94     void accumulate(double *res) const;
  95     double getMaxValue() const throw(INTERP_KERNEL::Exception);
  96     double getMaxValue2(DataArrayInt*& tupleIds) const throw(INTERP_KERNEL::Exception);
  97     double getMinValue() const throw(INTERP_KERNEL::Exception);
  98     double getMinValue2(DataArrayInt*& tupleIds) const throw(INTERP_KERNEL::Exception);
  99     double getAverageValue() const throw(INTERP_KERNEL::Exception);
 100     double norm2() const throw(INTERP_KERNEL::Exception);
 101     double normMax() const throw(INTERP_KERNEL::Exception);
 102     void getWeightedAverageValue(double *res, bool isWAbs=true) const throw(INTERP_KERNEL::Exception);
 103     double getWeightedAverageValue(int compId, bool isWAbs=true) const throw(INTERP_KERNEL::Exception);
 104     double normL1(int compId) const throw(INTERP_KERNEL::Exception);
 105     void normL1(double *res) const throw(INTERP_KERNEL::Exception);
 106     double normL2(int compId) const throw(INTERP_KERNEL::Exception);
 107     void normL2(double *res) const throw(INTERP_KERNEL::Exception);
 108     double integral(int compId, bool isWAbs) const throw(INTERP_KERNEL::Exception);
 109     void integral(bool isWAbs, double *res) const throw(INTERP_KERNEL::Exception);
 110     void getValueOnPos(int i, int j, int k, double *res) const throw(INTERP_KERNEL::Exception);
 111     void getValueOn(const double *spaceLoc, double *res) const throw(INTERP_KERNEL::Exception);
 112     void getValueOn(const double *spaceLoc, double time, double *res) const throw(INTERP_KERNEL::Exception);
 113     DataArrayDouble *getValueOnMulti(const double *spaceLoc, int nbOfPoints) const throw(INTERP_KERNEL::Exception);
 114     //! \b temporary
 115     void applyLin(double a, double b, int compoId);
 116     MEDCouplingFieldDouble &operator=(double value) throw(INTERP_KERNEL::Exception);
 117     void fillFromAnalytic(int nbOfComp, FunctionToEvaluate func) throw(INTERP_KERNEL::Exception);
 118     void fillFromAnalytic(int nbOfComp, const char *func) throw(INTERP_KERNEL::Exception);
 119     void fillFromAnalytic2(int nbOfComp, const char *func) throw(INTERP_KERNEL::Exception);
 120     void fillFromAnalytic3(int nbOfComp, const std::vector<std::string>& varsOrder, const char *func) throw(INTERP_KERNEL::Exception);
 121     void applyFunc(int nbOfComp, FunctionToEvaluate func);
 122     void applyFunc(int nbOfComp, double val);
 123     void applyFunc(int nbOfComp, const char *func) throw(INTERP_KERNEL::Exception);
 124     void applyFunc2(int nbOfComp, const char *func) throw(INTERP_KERNEL::Exception);
 125     void applyFunc3(int nbOfComp, const std::vector<std::string>& varsOrder, const char *func) throw(INTERP_KERNEL::Exception);
 126     void applyFunc(const char *func) throw(INTERP_KERNEL::Exception);
 127     void applyFuncFast32(const char *func) throw(INTERP_KERNEL::Exception);
 128     void applyFuncFast64(const char *func) throw(INTERP_KERNEL::Exception);
 129     int getNumberOfComponents() const throw(INTERP_KERNEL::Exception);
 130     int getNumberOfTuples() const throw(INTERP_KERNEL::Exception);
 131     int getNumberOfValues() const throw(INTERP_KERNEL::Exception);
 132     void updateTime() const;
 133     std::size_t getHeapMemorySize() const;
 134     //
 135     void getTinySerializationIntInformation(std::vector<int>& tinyInfo) const;
 136     void getTinySerializationDbleInformation(std::vector<double>& tinyInfo) const;
 137     void getTinySerializationStrInformation(std::vector<std::string>& tinyInfo) const;
 138     void resizeForUnserialization(const std::vector<int>& tinyInfoI, DataArrayInt *&dataInt, std::vector<DataArrayDouble *>& arrays);
 139     void finishUnserialization(const std::vector<int>& tinyInfoI, const std::vector<double>& tinyInfoD, const std::vector<std::string>& tinyInfoS);
 140     void serialize(DataArrayInt *&dataInt, std::vector<DataArrayDouble *>& arrays) const;
 141     //
 142     void changeUnderlyingMesh(const MEDCouplingMesh *other, int levOfCheck, double prec) throw(INTERP_KERNEL::Exception);
 143     void substractInPlaceDM(const MEDCouplingFieldDouble *f, int levOfCheck, double prec) throw(INTERP_KERNEL::Exception);
 144     bool mergeNodes(double eps, double epsOnVals=1e-15) throw(INTERP_KERNEL::Exception);
 145     bool mergeNodes2(double eps, double epsOnVals=1e-15) throw(INTERP_KERNEL::Exception);
 146     bool zipCoords(double epsOnVals=1e-15) throw(INTERP_KERNEL::Exception);
 147     bool zipConnectivity(int compType, double epsOnVals=1e-15) throw(INTERP_KERNEL::Exception);
 148     MEDCouplingFieldDouble *extractSlice3D(const double *origin, const double *vec, double eps) const throw(INTERP_KERNEL::Exception);
 149     bool simplexize(int policy) throw(INTERP_KERNEL::Exception);
 150     MEDCouplingFieldDouble *doublyContractedProduct() const throw(INTERP_KERNEL::Exception);
 151     MEDCouplingFieldDouble *determinant() const throw(INTERP_KERNEL::Exception);
 152     MEDCouplingFieldDouble *eigenValues() const throw(INTERP_KERNEL::Exception);
 153     MEDCouplingFieldDouble *eigenVectors() const throw(INTERP_KERNEL::Exception);
 154     MEDCouplingFieldDouble *inverse() const throw(INTERP_KERNEL::Exception);
 155     MEDCouplingFieldDouble *trace() const throw(INTERP_KERNEL::Exception);
 156     MEDCouplingFieldDouble *deviator() const throw(INTERP_KERNEL::Exception);
 157     MEDCouplingFieldDouble *magnitude() const throw(INTERP_KERNEL::Exception);
 158     MEDCouplingFieldDouble *maxPerTuple() const throw(INTERP_KERNEL::Exception);
 159     void changeNbOfComponents(int newNbOfComp, double dftValue=0.) throw(INTERP_KERNEL::Exception);
 160     MEDCouplingFieldDouble *keepSelectedComponents(const std::vector<int>& compoIds) const throw(INTERP_KERNEL::Exception);
 161     void setSelectedComponents(const MEDCouplingFieldDouble *f, const std::vector<int>& compoIds) throw(INTERP_KERNEL::Exception);
 162     void sortPerTuple(bool asc) throw(INTERP_KERNEL::Exception);
 163     static MEDCouplingFieldDouble *MergeFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 164     static MEDCouplingFieldDouble *MergeFields(const std::vector<const MEDCouplingFieldDouble *>& a) throw(INTERP_KERNEL::Exception);
 165     static MEDCouplingFieldDouble *MeldFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 166     static MEDCouplingFieldDouble *DotFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 167     MEDCouplingFieldDouble *dot(const MEDCouplingFieldDouble& other) const throw(INTERP_KERNEL::Exception) { return DotFields(this,&other); }
 168     static MEDCouplingFieldDouble *CrossProductFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 169     MEDCouplingFieldDouble *crossProduct(const MEDCouplingFieldDouble& other) const throw(INTERP_KERNEL::Exception) { return CrossProductFields(this,&other); }
 170     static MEDCouplingFieldDouble *MaxFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 171     MEDCouplingFieldDouble *max(const MEDCouplingFieldDouble& other) const throw(INTERP_KERNEL::Exception) { return MaxFields(this,&other); }
 172     static MEDCouplingFieldDouble *MinFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 173     MEDCouplingFieldDouble *min(const MEDCouplingFieldDouble& other) const throw(INTERP_KERNEL::Exception) { return MinFields(this,&other); }
 174     MEDCouplingFieldDouble *operator+(const MEDCouplingFieldDouble& other) const throw(INTERP_KERNEL::Exception) { return AddFields(this,&other); }
 175     const MEDCouplingFieldDouble &operator+=(const MEDCouplingFieldDouble& other) throw(INTERP_KERNEL::Exception);
 176     static MEDCouplingFieldDouble *AddFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 177     MEDCouplingFieldDouble *operator-(const MEDCouplingFieldDouble& other) const throw(INTERP_KERNEL::Exception) { return SubstractFields(this,&other); }
 178     const MEDCouplingFieldDouble &operator-=(const MEDCouplingFieldDouble& other) throw(INTERP_KERNEL::Exception);
 179     static MEDCouplingFieldDouble *SubstractFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 180     MEDCouplingFieldDouble *operator*(const MEDCouplingFieldDouble& other) const throw(INTERP_KERNEL::Exception) { return MultiplyFields(this,&other); }
 181     const MEDCouplingFieldDouble &operator*=(const MEDCouplingFieldDouble& other) throw(INTERP_KERNEL::Exception);
 182     static MEDCouplingFieldDouble *MultiplyFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 183     MEDCouplingFieldDouble *operator/(const MEDCouplingFieldDouble& other) const throw(INTERP_KERNEL::Exception) { return DivideFields(this,&other); }
 184     const MEDCouplingFieldDouble &operator/=(const MEDCouplingFieldDouble& other) throw(INTERP_KERNEL::Exception);
 185     static MEDCouplingFieldDouble *DivideFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2) throw(INTERP_KERNEL::Exception);
 186     static void WriteVTK(const char *fileName, const std::vector<const MEDCouplingFieldDouble *>& fs) throw(INTERP_KERNEL::Exception);
 187   public:
 188     const MEDCouplingTimeDiscretization *getTimeDiscretizationUnderGround() const { return _time_discr; }
 189     MEDCouplingTimeDiscretization *getTimeDiscretizationUnderGround() { return _time_discr; }
 190   private:
 191     MEDCouplingFieldDouble(TypeOfField type, TypeOfTimeDiscretization td);
 192     MEDCouplingFieldDouble(const MEDCouplingFieldTemplate& ft, TypeOfTimeDiscretization td);
 193     MEDCouplingFieldDouble(const MEDCouplingFieldDouble& other, bool deepCopy);
 194     MEDCouplingFieldDouble(NatureOfField n, MEDCouplingTimeDiscretization *td, MEDCouplingFieldDiscretization *type);
 195     ~MEDCouplingFieldDouble();
 196   private:
 197     MEDCouplingTimeDiscretization *_time_discr;
 198   };
 199 }
 200
 201 #endif