Salome HOME
Extra deps update
[tools/medcoupling.git] / src / MEDCoupling / MEDCouplingFieldT.txx
index 7f6819c18ec2fda9d5e32ac6b179582f8a59229a..7c5a2f6ab2fc89f3d99af24762b650c78c6ef0fa 100644 (file)
@@ -117,21 +117,22 @@ namespace MEDCoupling
       }
     return ret.retn();
   }
+
+  template<class T>
+  bool MEDCouplingFieldT<T>::isEqual(const MEDCouplingFieldT<T> *other, double meshPrec, T valsPrec) const
+  {
+    std::string tmp;
+    return isEqualIfNotWhy(other,meshPrec,valsPrec,tmp);
+  }
   
   template<class T>
-  bool MEDCouplingFieldT<T>::isEqualIfNotWhy(const MEDCouplingField *other, double meshPrec, double valsPrec, std::string& reason) const
+  bool MEDCouplingFieldT<T>::isEqualIfNotWhy(const MEDCouplingFieldT<T> *other, double meshPrec, T valsPrec, std::string& reason) const
   {
     if(!other)
       throw INTERP_KERNEL::Exception("MEDCouplingFieldT::isEqualIfNotWhy : other instance is NULL !");
-    const MEDCouplingFieldT<T> *otherC(dynamic_cast<const MEDCouplingFieldT<T> *>(other));
-    if(!otherC)
-      {
-        reason="field given in input is not castable in MEDCouplingFieldT !";
-        return false;
-      }
-    if(!MEDCouplingField::isEqualIfNotWhy(other,meshPrec,valsPrec,reason))
+    if(!isEqualIfNotWhyProtected(other,meshPrec,reason))
       return false;
-    if(!_time_discr->isEqualIfNotWhy(otherC->_time_discr,T(valsPrec),reason))
+    if(!_time_discr->isEqualIfNotWhy(other->_time_discr,T(valsPrec),reason))
       {
         reason.insert(0,"In FieldT time discretizations differ :");
         return false;
@@ -150,14 +151,13 @@ namespace MEDCoupling
    *  \throw If the spatial discretization of \a this field is NULL.
    */
   template<class T>
-  bool MEDCouplingFieldT<T>::isEqualWithoutConsideringStr(const MEDCouplingField *other, double meshPrec, double valsPrec) const
+  bool MEDCouplingFieldT<T>::isEqualWithoutConsideringStr(const MEDCouplingFieldT<T> *other, double meshPrec, T valsPrec) const
   {
-    const MEDCouplingFieldT<T> *otherC(dynamic_cast<const MEDCouplingFieldT<T> *>(other));
-    if(!otherC)
+    if(!other)
       return false;
-    if(!MEDCouplingField::isEqualWithoutConsideringStr(other,meshPrec,valsPrec))
+    if(!isEqualWithoutConsideringStrProtected(other,meshPrec))
       return false;
-    if(!_time_discr->isEqualWithoutConsideringStr(otherC->_time_discr,T(valsPrec)))
+    if(!_time_discr->isEqualWithoutConsideringStr(other->_time_discr,valsPrec))
       return false;
     return true;
   }
@@ -203,6 +203,78 @@ namespace MEDCoupling
     copyTinyAttrFrom(other);
   }
   
+  /*!
+   * Permutes values of \a this field according to a given permutation array for cells
+   * renumbering. The underlying mesh is deeply copied and its cells are also permuted. 
+   * The number of cells remains the same; for that the permutation array \a old2NewBg
+   * should not contain equal ids.
+   * ** Warning, this method modifies the mesh aggreagated by \a this (by performing a deep copy ) **.
+   *
+   *  \param [in] old2NewBg - the permutation array in "Old to New" mode. Its length is
+   *         to be equal to \a this->getMesh()->getNumberOfCells().
+   *  \param [in] check - if \c true, \a old2NewBg is transformed to a new permutation
+   *         array, so that its maximal cell id to correspond to (be less than) the number
+   *         of cells in mesh. This new array is then used for the renumbering. If \a 
+   *         check == \c false, \a old2NewBg is used as is, that is less secure as validity 
+   *         of ids in \a old2NewBg is not checked.
+   *  \throw If the mesh is not set.
+   *  \throw If the spatial discretization of \a this field is NULL.
+   *  \throw If \a check == \c true and \a old2NewBg contains equal ids.
+   *  \throw If mesh nature does not allow renumbering (e.g. structured mesh).
+   * 
+   *  \if ENABLE_EXAMPLES
+   *  \ref cpp_mcfielddouble_renumberCells "Here is a C++ example".<br>
+   *  \ref  py_mcfielddouble_renumberCells "Here is a Python example".
+   *  \endif
+   */
+  template<class T>
+  void MEDCouplingFieldT<T>::renumberCells(const int *old2NewBg, bool check)
+  {
+    renumberCellsWithoutMesh(old2NewBg,check);
+    MCAuto<MEDCouplingMesh> m(_mesh->deepCopy());
+    m->renumberCells(old2NewBg,check);
+    setMesh(m);
+    updateTime();
+  }
+
+  /*!
+   * Permutes values of \a this field according to a given permutation array for cells
+   * renumbering. The underlying mesh is \b not permuted. 
+   * The number of cells remains the same; for that the permutation array \a old2NewBg
+   * should not contain equal ids.
+   * This method performs a part of job of renumberCells(). The reasonable use of this
+   * method is only for multi-field instances lying on the same mesh to avoid a
+   * systematic duplication and renumbering of _mesh attribute. 
+   * \warning Use this method with a lot of care!
+   *  \param [in] old2NewBg - the permutation array in "Old to New" mode. Its length is
+   *         to be equal to \a this->getMesh()->getNumberOfCells().
+   *  \param [in] check - if \c true, \a old2NewBg is transformed to a new permutation
+   *         array, so that its maximal cell id to correspond to (be less than) the number
+   *         of cells in mesh. This new array is then used for the renumbering. If \a 
+   *         check == \c false, \a old2NewBg is used as is, that is less secure as validity 
+   *         of ids in \a old2NewBg is not checked.
+   *  \throw If the mesh is not set.
+   *  \throw If the spatial discretization of \a this field is NULL.
+   *  \throw If \a check == \c true and \a old2NewBg contains equal ids.
+   *  \throw If mesh nature does not allow renumbering (e.g. structured mesh).
+   */
+  template<class T>
+  void MEDCouplingFieldT<T>::renumberCellsWithoutMesh(const int *old2NewBg, bool check)
+  {
+    if(!_mesh)
+      throw INTERP_KERNEL::Exception("Expecting a defined mesh to be able to operate a renumbering !");
+    if(_type.isNull())
+      throw INTERP_KERNEL::Exception("Expecting a spatial discretization to be able to operate a renumbering !");
+    //
+    _type->renumberCells(old2NewBg,check);
+    std::vector< typename MEDCoupling::Traits<T>::ArrayType *> arrays;
+    timeDiscrSafe()->getArrays(arrays);
+    std::vector<DataArray *> arrays2(arrays.size()); std::copy(arrays.begin(),arrays.end(),arrays2.begin());
+    _type->renumberArraysForCell(_mesh,arrays2,old2NewBg,check);
+    //
+    updateTime();
+  }
+  
   /*!
    * This method is more strict than MEDCouplingField::areCompatibleForMerge method.
    * This method is used for operation on fields to operate a first check before attempting operation.
@@ -369,7 +441,7 @@ namespace MEDCoupling
   }
 
   /*!
-   * Builds a newly created field, that the caller will have the responsability to deal with.
+   * Builds a newly created field, that the caller will have the responsibility to deal with.
    * \n This method makes the assumption that \a this field is correctly defined when this method is called (\a this->checkConsistencyLight() returns without any exception thrown), **no check of this will be done**.
    * \n This method returns a restriction of \a this so that only tuple ids specified in [ \a partBg , \a partEnd ) will be contained in the returned field.
    * \n Parameter [\a partBg, \a partEnd ) specifies **cell ids whatever the spatial discretization** of \a this (
@@ -432,7 +504,7 @@ namespace MEDCoupling
   }
 
   /*!
-   * Builds a newly created field, that the caller will have the responsability to deal with (decrRef()).
+   * Builds a newly created field, that the caller will have the responsibility to deal with (decrRef()).
    * This method makes the assumption that the field is correctly defined when this method is called, no check of this will be done.
    * This method returns a restriction of \a this so that only tuples with ids specified in \a part will be contained in the returned field.
    * Parameter \a part specifies **cell ids whatever the spatial discretization of this** (
@@ -530,6 +602,133 @@ namespace MEDCoupling
       throw INTERP_KERNEL::Exception("const FieldT : Null type of time discr !");
     return ret;
   }
+
+  template<class T>
+  void MEDCouplingFieldT<T>::getTinySerializationStrInformation(std::vector<std::string>& tinyInfo) const
+  {
+    tinyInfo.clear();
+    timeDiscrSafe()->getTinySerializationStrInformation(tinyInfo);
+    tinyInfo.push_back(_name);
+    tinyInfo.push_back(_desc);
+    tinyInfo.push_back(getTimeUnit());
+  }
+
+  /*!
+   * This method retrieves some critical values to resize and prepare remote instance.
+   * The first two elements returned in tinyInfo correspond to the parameters to give in constructor.
+   * @param tinyInfo out parameter resized correctly after the call. The length of this vector is tiny.
+   */
+  template<class T>
+  void MEDCouplingFieldT<T>::getTinySerializationIntInformation(std::vector<int>& tinyInfo) const
+  {
+    if(_type.isNull())
+      throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getTinySerializationIntInformation !");
+    tinyInfo.clear();
+    tinyInfo.push_back((int)_type->getEnum());
+    tinyInfo.push_back((int)timeDiscrSafe()->getEnum());
+    tinyInfo.push_back((int)_nature);
+    timeDiscrSafe()->getTinySerializationIntInformation(tinyInfo);
+    std::vector<int> tinyInfo2;
+    _type->getTinySerializationIntInformation(tinyInfo2);
+    tinyInfo.insert(tinyInfo.end(),tinyInfo2.begin(),tinyInfo2.end());
+    tinyInfo.push_back((int)tinyInfo2.size());
+  }
+
+  /*!
+   * This method retrieves some critical values to resize and prepare remote instance.
+   * @param tinyInfo out parameter resized correctly after the call. The length of this vector is tiny.
+   */
+  template<class T>
+  void MEDCouplingFieldT<T>::getTinySerializationDbleInformation(std::vector<double>& tinyInfo) const
+  {
+    if(_type.isNull())
+      throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getTinySerializationDbleInformation !");
+    tinyInfo.clear();
+    timeDiscrSafe()->getTinySerializationDbleInformation(tinyInfo);
+    std::vector<double> tinyInfo2;
+    _type->getTinySerializationDbleInformation(tinyInfo2);
+    tinyInfo.insert(tinyInfo.end(),tinyInfo2.begin(),tinyInfo2.end());
+    tinyInfo.push_back((int)tinyInfo2.size());//very bad, lack of time to improve it
+  }
+
+  /*!
+   * This method has to be called to the new instance filled by CORBA, MPI, File...
+   * @param tinyInfoI is the value retrieves from distant result of getTinySerializationIntInformation on source instance to be copied.
+   * @param dataInt out parameter. If not null the pointer is already owned by \a this after the call of this method. In this case no decrRef must be applied.
+   * @param arrays out parameter is a vector resized to the right size. The pointers in the vector is already owned by \a this after the call of this method.
+   *               No decrRef must be applied to every instances in returned vector.
+   * \sa checkForUnserialization
+   */
+  template<class T>
+  void MEDCouplingFieldT<T>::resizeForUnserialization(const std::vector<int>& tinyInfoI, DataArrayInt *&dataInt, std::vector<typename Traits<T>::ArrayType *>& arrays)
+  {
+    if(_type.isNull())
+      throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform resizeForUnserialization !");
+    dataInt=0;
+    std::vector<int> tinyInfoITmp(tinyInfoI);
+    int sz=tinyInfoITmp.back();
+    tinyInfoITmp.pop_back();
+    std::vector<int> tinyInfoITmp2(tinyInfoITmp.begin(),tinyInfoITmp.end()-sz);
+    std::vector<int> tinyInfoI2(tinyInfoITmp2.begin()+3,tinyInfoITmp2.end());
+    timeDiscrSafe()->resizeForUnserialization(tinyInfoI2,arrays);
+    std::vector<int> tinyInfoITmp3(tinyInfoITmp.end()-sz,tinyInfoITmp.end());
+    _type->resizeForUnserialization(tinyInfoITmp3,dataInt);
+  }
+
+  /*!
+   * This method is extremely close to resizeForUnserialization except that here the arrays in \a dataInt and in \a arrays are attached in \a this
+   * after having checked that size is correct. This method is used in python pickeling context to avoid copy of data.
+   * \sa resizeForUnserialization
+   */
+  template<class T>
+  void MEDCouplingFieldT<T>::checkForUnserialization(const std::vector<int>& tinyInfoI, const DataArrayInt *dataInt, const std::vector<typename Traits<T>::ArrayType *>& arrays)
+  {
+    if(_type.isNull())
+      throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform resizeForUnserialization !");
+    std::vector<int> tinyInfoITmp(tinyInfoI);
+    int sz=tinyInfoITmp.back();
+    tinyInfoITmp.pop_back();
+    std::vector<int> tinyInfoITmp2(tinyInfoITmp.begin(),tinyInfoITmp.end()-sz);
+    std::vector<int> tinyInfoI2(tinyInfoITmp2.begin()+3,tinyInfoITmp2.end());
+    timeDiscrSafe()->checkForUnserialization(tinyInfoI2,arrays);
+    std::vector<int> tinyInfoITmp3(tinyInfoITmp.end()-sz,tinyInfoITmp.end());
+    _type->checkForUnserialization(tinyInfoITmp3,dataInt);
+  }
+
+  template<class T>
+  void MEDCouplingFieldT<T>::finishUnserialization(const std::vector<int>& tinyInfoI, const std::vector<double>& tinyInfoD, const std::vector<std::string>& tinyInfoS)
+  {
+    if(_type.isNull())
+      throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform finishUnserialization !");
+    std::vector<int> tinyInfoI2(tinyInfoI.begin()+3,tinyInfoI.end());
+    //
+    std::vector<double> tmp(tinyInfoD);
+    int sz=(int)tinyInfoD.back();//very bad, lack of time to improve it
+    tmp.pop_back();
+    std::vector<double> tmp1(tmp.begin(),tmp.end()-sz);
+    std::vector<double> tmp2(tmp.end()-sz,tmp.end());
+    //
+    timeDiscrSafe()->finishUnserialization(tinyInfoI2,tmp1,tinyInfoS);
+    _nature=(NatureOfField)tinyInfoI[2];
+    _type->finishUnserialization(tmp2);
+    int nbOfElemS=(int)tinyInfoS.size();
+    _name=tinyInfoS[nbOfElemS-3];
+    _desc=tinyInfoS[nbOfElemS-2];
+    setTimeUnit(tinyInfoS[nbOfElemS-1]);
+  }
+
+  /*!
+   * Contrary to MEDCouplingPointSet class the returned arrays are \b not the responsibilities of the caller.
+   * The values returned must be consulted only in readonly mode.
+   */
+  template<class T>
+  void MEDCouplingFieldT<T>::serialize(DataArrayInt *&dataInt, std::vector<typename Traits<T>::ArrayType *>& arrays) const
+  {
+    if(_type.isNull())
+      throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform serialize !");
+    timeDiscrSafe()->getArrays(arrays);
+    _type->getSerializationIntArray(dataInt);
+  }
 }
 
 #endif