src/MEDCoupling/MEDCouplingMesh.cxx

   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 #include "MEDCouplingMesh.hxx"
  22 #include "MEDCouplingUMesh.hxx"
  23 #include "MEDCouplingMemArray.hxx"
  24 #include "MEDCouplingFieldDouble.hxx"
  25 #include "MEDCouplingFieldDiscretization.hxx"
  26 #include "MEDCouplingAutoRefCountObjectPtr.hxx"
  27
  28 #include <set>
  29 #include <cmath>
  30 #include <sstream>
  31 #include <fstream>
  32 #include <iterator>
  33
  34 using namespace ParaMEDMEM;
  35
  36 MEDCouplingMesh::MEDCouplingMesh():_time(0.),_iteration(-1),_order(-1)
  37 {
  38 }
  39
  40 MEDCouplingMesh::MEDCouplingMesh(const MEDCouplingMesh& other):_name(other._name),_description(other._description),
  41                                                                _time(other._time),_iteration(other._iteration),
  42                                                                _order(other._order),_time_unit(other._time_unit)
  43 {
  44 }
  45
  46 /*!
  47  * This method is only for ParaMEDMEM in ParaFIELD constructor.
  48  */
  49 bool MEDCouplingMesh::isStructured() const
  50 {
  51   return getType()==CARTESIAN;
  52 }
  53
  54 bool MEDCouplingMesh::isEqualIfNotWhy(const MEDCouplingMesh *other, double prec, std::string& reason) const throw(INTERP_KERNEL::Exception)
  55 {
  56   if(!other)
  57     throw INTERP_KERNEL::Exception("MEDCouplingMesh::isEqualIfNotWhy : other instance is NULL !");
  58   std::ostringstream oss; oss.precision(15);
  59   if(_name!=other->_name)
  60     {
  61       oss << "Mesh names differ : this name = \"" << _name << "\" and other name = \"" << other->_name << "\" !";
  62       reason=oss.str();
  63       return false;
  64     }
  65   if(_description!=other->_description)
  66     {
  67       oss << "Mesh descriptions differ : this description = \"" << _description << "\" and other description = \"" << other->_description << "\" !";
  68       reason=oss.str();
  69       return false;
  70     }
  71   if(_iteration!=other->_iteration)
  72     {
  73       oss << "Mesh iterations differ : this iteration = \"" << _iteration << "\" and other iteration = \"" << other->_iteration << "\" !";
  74       reason=oss.str();
  75       return false;
  76     }
  77   if(_order!=other->_order)
  78     {
  79       oss << "Mesh orders differ : this order = \"" << _order << "\" and other order = \"" << other->_order << "\" !";
  80       reason=oss.str();
  81       return false;
  82     }
  83   if(_time_unit!=other->_time_unit)
  84     {
  85       oss << "Mesh time units differ : this time unit = \"" << _time_unit << "\" and other time unit = \"" << other->_time_unit << "\" !";
  86       reason=oss.str();
  87       return false;
  88     }
  89   if(fabs(_time-other->_time)>=1e-12)
  90     {
  91       oss << "Mesh times differ : this time = \"" << _time << "\" and other time = \"" << other->_time << "\" !";
  92       reason=oss.str();
  93       return false;
  94     }
  95   return true;
  96 }
  97
  98 bool MEDCouplingMesh::isEqual(const MEDCouplingMesh *other, double prec) const throw(INTERP_KERNEL::Exception)
  99 {
 100   std::string tmp;
 101   return isEqualIfNotWhy(other,prec,tmp);
 102 }
 103
 104 /*!
 105  * This method checks geo equivalence between two meshes : 'this' and 'other'.
 106  * If no exception is throw 'this' and 'other' are geometrically equivalent regarding 'levOfCheck' level.
 107  * This method is typically used to change the mesh of a field "safely" depending the 'levOfCheck' level considered.
 108  *
 109  * @param levOfCheck input that specifies the level of check specified. The possible values are listed below.
 110  * @param prec input that specifies precision for double float data used for comparison in meshes.
 111  * @param cellCor output array not always informed (depending 'levOfCheck' param) that gives the corresponding array for cells from 'other' to 'this'.
 112  * @param nodeCor output array not always informed (depending 'levOfCheck' param) that gives the corresponding array for nodes from 'other' to 'this'.
 113  *
 114  * Possible values for levOfCheck :
 115  *   - 0 for strict equality. This is the strongest level. 'cellCor' and 'nodeCor' params are never informed.
 116  *   - 10,11,12 for less strict equality. Two meshes are compared geometrically. In case of success 'cellCor' and 'nodeCor' are informed. Warning ! These equivalences are CPU/Mem costly. The 3 values correspond respectively to policy used for cell comparison (see MEDCouplingUMesh::zipConnectivityTraducer to have more details)
 117  *   - 20,21,22, for less strict equality. Two meshes are compared geometrically. The difference with the previous version is that nodes(coordinates) are expected to be the same between this and other. In case of success 'cellCor' is informed. Warning ! These equivalences are CPU/Mem costly. The 3 values correspond respectively to policy used for cell comparison (see MEDCouplingUMesh::zipConnectivityTraducer to have more details)
 118  *   - 1 for fast 'equality'. This is a lazy level. Just number of cells and number of nodes are considered here and 3 cells (begin,middle,end)
 119  *   - 2 for deep 'equality' as 0 option except that no control is done on all strings in mesh.
 120  */
 121 void MEDCouplingMesh::checkGeoEquivalWith(const MEDCouplingMesh *other, int levOfCheck, double prec,
 122                                           DataArrayInt *&cellCor, DataArrayInt *&nodeCor) const throw(INTERP_KERNEL::Exception)
 123 {
 124   cellCor=0;
 125   nodeCor=0;
 126   if(this==other)
 127     return ;
 128   switch(levOfCheck)
 129     {
 130     case 0:
 131       {
 132         if(!isEqual(other,prec))
 133           throw INTERP_KERNEL::Exception("checkGeoFitWith : Meshes are not equal !");
 134         return ;
 135       }
 136     case 10:
 137     case 11:
 138     case 12:
 139       {
 140         checkDeepEquivalWith(other,levOfCheck-10,prec,cellCor,nodeCor);
 141         return ;
 142       }
 143     case 20:
 144     case 21:
 145     case 22:
 146       {
 147         checkDeepEquivalOnSameNodesWith(other,levOfCheck-20,prec,cellCor);
 148         return ;
 149       }
 150     case 1:
 151       {
 152         checkFastEquivalWith(other,prec);
 153         return;
 154       }
 155     case 2:
 156       {
 157         if(!isEqualWithoutConsideringStr(other,prec))
 158           throw INTERP_KERNEL::Exception("checkGeoFitWith : Meshes are not equal without considering strings !");
 159         return ;
 160       }
 161     default:
 162       throw INTERP_KERNEL::Exception("checkGeoFitWith : Invalid levOfCheck specified ! Value must be in 0,1,2,10,11 or 12.");
 163     }
 164 }
 165
 166 /*!
 167  * Given a nodeIds range ['partBg','partEnd'), this method returns the set of cell ids in ascendant order whose connectivity of
 168  * these cells are fully included in the range. As a consequence the returned set of cell ids does \b not \b always fit the nodes in ['partBg','partEnd')
 169  * This method returns the corresponding cells in a newly created array that the caller has the responsability.
 170  */
 171 DataArrayInt *MEDCouplingMesh::getCellIdsFullyIncludedInNodeIds(const int *partBg, const int *partEnd) const
 172 {
 173   std::vector<int> crest;
 174   std::set<int> p(partBg,partEnd);
 175   int nbOfCells=getNumberOfCells();
 176   for(int i=0;i<nbOfCells;i++)
 177     {
 178       std::vector<int> conn;
 179       getNodeIdsOfCell(i,conn);
 180       bool cont=true;
 181       for(std::vector<int>::const_iterator iter=conn.begin();iter!=conn.end() && cont;iter++)
 182         if(p.find(*iter)==p.end())
 183           cont=false;
 184       if(cont)
 185         crest.push_back(i);
 186     }
 187   DataArrayInt *ret=DataArrayInt::New();
 188   ret->alloc((int)crest.size(),1);
 189   std::copy(crest.begin(),crest.end(),ret->getPointer());
 190   return ret;
 191 }
 192
 193 /*!
 194  * This method checks fastly that 'this' and 'other' are equal. All common checks are done here.
 195  */
 196 void MEDCouplingMesh::checkFastEquivalWith(const MEDCouplingMesh *other, double prec) const throw(INTERP_KERNEL::Exception)
 197 {
 198   if(getMeshDimension()!=other->getMeshDimension())
 199     throw INTERP_KERNEL::Exception("checkFastEquivalWith : Mesh dimensions are not equal !");
 200   if(getSpaceDimension()!=other->getSpaceDimension())
 201     throw INTERP_KERNEL::Exception("checkFastEquivalWith : Space dimensions are not equal !");
 202   if(getNumberOfCells()!=other->getNumberOfCells())
 203     throw INTERP_KERNEL::Exception("checkFastEquivalWith : number of cells are not equal !");
 204 }
 205
 206 /*!
 207  * This method is very poor and looks only if 'this' and 'other' are candidate for merge of fields lying repectively on them.
 208  */
 209 bool MEDCouplingMesh::areCompatibleForMerge(const MEDCouplingMesh *other) const
 210 {
 211   if(getMeshDimension()!=other->getMeshDimension())
 212     return false;
 213   if(getSpaceDimension()!=other->getSpaceDimension())
 214     return false;
 215   return true;
 216 }
 217
 218 /*!
 219  * This method builds a field lying on 'this' with 'nbOfComp' components.
 220  * 'func' is a pointer that points to a function that takes 2 arrays in parameter and returns a boolean.
 221  * The first array is a in-param of size this->getSpaceDimension and the second an out param of size 'nbOfComp'.
 222  * The return field will have type specified by 't'. 't' is also used to determine where values of field will be
 223  * evaluate.
 224  * Contrary to other fillFromAnalytic methods this method requests a C++ function pointer as input.
 225  * The 'func' is a callback that takes as first parameter an input array of size 'this->getSpaceDimension()',
 226  * the second parameter is a pointer on a valid zone of size at least equal to 'nbOfComp' values. And too finish
 227  * the returned value is a boolean that is equal to False in case of invalid evaluation (log(0) for example...)
 228  * @param t type of field returned and specifies where the evaluation of func will be done.
 229  * @param nbOfComp number of components of returned field.
 230  * @param func pointer to a function that should return false if the evaluation failed. (division by 0. for example)
 231  * @return field with counter = 1.
 232  */
 233 MEDCouplingFieldDouble *MEDCouplingMesh::fillFromAnalytic(TypeOfField t, int nbOfComp, FunctionToEvaluate func) const
 234 {
 235   MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=MEDCouplingFieldDouble::New(t,NO_TIME);
 236   ret->setMesh(this);
 237   ret->fillFromAnalytic(nbOfComp,func);
 238   ret->incrRef();
 239   return ret;
 240 }
 241
 242 /*!
 243  * This method copyies all tiny strings from other (name and components name).
 244  * @throw if other and this have not same mesh type.
 245  */
 246 void MEDCouplingMesh::copyTinyStringsFrom(const MEDCouplingMesh *other) throw(INTERP_KERNEL::Exception)
 247 {
 248   _name=other->_name;
 249   _description=other->_description;
 250   _time_unit=other->_time_unit;
 251 }
 252
 253 /*!
 254  * This method copies all attributes that are \b NOT arrays in this.
 255  * All tiny attributes not usefully for state of 'this' are ignored.
 256  */
 257 void MEDCouplingMesh::copyTinyInfoFrom(const MEDCouplingMesh *other) throw(INTERP_KERNEL::Exception)
 258 {
 259   copyTinyStringsFrom(other);
 260   _time=other->_time;
 261   _iteration=other->_iteration;
 262   _order=other->_order;
 263 }
 264
 265 /*!
 266  * This method builds a field lying on 'this' with 'nbOfComp' components.
 267  * 'func' is a string that is the expression to evaluate.
 268  * The return field will have type specified by 't'. 't' is also used to determine where values of field will be
 269  * evaluate.
 270  * This method is equivalent to those taking a C++ function pointer except that here the 'func' is informed by
 271  * an interpretable input string.
 272  *
 273  * The dynamic interpretor uses \b alphabetical \b order to assign the component id to the var name.
 274  * For example :
 275  * - "2*x+z" func : x stands for component #0 and z stands for component #1 \b NOT #2 !
 276  *
 277  * Some var names are reserved and have special meaning. IVec stands for (1,0,0,...). JVec stands for (0,1,0...).
 278  * KVec stands for (0,0,1,...)... These keywords allows too differentate the evaluation of output components each other.
 279  *
 280  * If 'nbOfComp' equals to 4 for example and that 'this->getSpaceDimension()' equals to 3.
 281  *
 282  * For the input tuple T = (1.,3.,7.) :
 283  *   - '2*x+z' will return (5.,5.,5.,5.)
 284  *   - '2*x+0*y+z' will return (9.,9.,9.,9.)
 285  *   - '2*x*IVec+(x+z)*LVec' will return (2.,0.,0.,4.)
 286  *   - '2*x*IVec+(y+z)*KVec' will return (2.,0.,10.,0.)
 287  *
 288  * @param t type of field returned and specifies where the evaluation of func will be done.
 289  * @param nbOfComp number of components of returned field.
 290  * @param func expression.
 291  * @return field with counter = 1.
 292  */
 293 MEDCouplingFieldDouble *MEDCouplingMesh::fillFromAnalytic(TypeOfField t, int nbOfComp, const char *func) const
 294 {
 295   MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=MEDCouplingFieldDouble::New(t,NO_TIME);
 296   ret->setMesh(this);
 297   ret->fillFromAnalytic(nbOfComp,func);
 298   ret->incrRef();
 299   return ret;
 300 }
 301
 302 /*!
 303  * This method builds a field lying on 'this' with 'nbOfComp' components.
 304  * 'func' is a string that is the expression to evaluate.
 305  * The return field will have type specified by 't'. 't' is also used to determine where values of field will be
 306  * evaluate. This method is different than MEDCouplingMesh::fillFromAnalytic, because the info on components are used here to determine vars pos in 'func'.
 307  *
 308  * @param t type of field returned and specifies where the evaluation of func will be done.
 309  * @param nbOfComp number of components of returned field.
 310  * @param func expression.
 311  * @return field with counter = 1.
 312  */
 313 MEDCouplingFieldDouble *MEDCouplingMesh::fillFromAnalytic2(TypeOfField t, int nbOfComp, const char *func) const
 314 {
 315   MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=MEDCouplingFieldDouble::New(t,NO_TIME);
 316   ret->setMesh(this);
 317   ret->fillFromAnalytic2(nbOfComp,func);
 318   ret->incrRef();
 319   return ret;
 320 }
 321
 322 /*!
 323  * This method builds a field lying on 'this' with 'nbOfComp' components.
 324  * 'func' is a string that is the expression to evaluate.
 325  * The return field will have type specified by 't'. 't' is also used to determine where values of field will be
 326  * evaluate. This method is different than MEDCouplingMesh::fillFromAnalytic, because 'varsOrder' specifies the pos to assign of vars in 'func'.
 327  *
 328  * @param t type of field returned and specifies where the evaluation of func will be done.
 329  * @param nbOfComp number of components of returned field.
 330  * @param func expression.
 331  * @return field with counter = 1.
 332  */
 333 MEDCouplingFieldDouble *MEDCouplingMesh::fillFromAnalytic3(TypeOfField t, int nbOfComp, const std::vector<std::string>& varsOrder, const char *func) const
 334 {
 335   MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=MEDCouplingFieldDouble::New(t,NO_TIME);
 336   ret->setMesh(this);
 337   ret->fillFromAnalytic3(nbOfComp,varsOrder,func);
 338   ret->incrRef();
 339   return ret;
 340 }
 341
 342 /*!
 343  * retruns a newly created mesh with counter=1
 344  * that is the union of \b mesh1 and \b mesh2 if possible. The cells of \b mesh2 will appear after cells of \b mesh1. Idem for nodes.
 345  * The only contraint is that \b mesh1 an \b mesh2 have the same mesh types. If it is not the case please use the other API of MEDCouplingMesh::MergeMeshes,
 346  * with input vector of meshes.
 347  */
 348 MEDCouplingMesh *MEDCouplingMesh::MergeMeshes(const MEDCouplingMesh *mesh1, const MEDCouplingMesh *mesh2) throw(INTERP_KERNEL::Exception)
 349 {
 350   if(!mesh1)
 351     throw INTERP_KERNEL::Exception("MEDCouplingMesh::MergeMeshes : first parameter is an empty mesh !");
 352   if(!mesh2)
 353     throw INTERP_KERNEL::Exception("MEDCouplingMesh::MergeMeshes : second parameter is an empty mesh !");
 354   return mesh1->mergeMyselfWith(mesh2);
 355 }
 356
 357 /*!
 358  * retruns a newly created mesh with counter=1
 359  * that is the union of meshes if possible. The cells of \b meshes[1] will appear after cells of \b meshes[0]. Idem for nodes.
 360  * This method performs a systematic conversion to unstructured meshes before performing aggregation contrary to the other ParaMEDMEM::MEDCouplingMesh::MergeMeshes with
 361  * two parameters that work only on the same type of meshes. So here it is possible to mix different type of meshes.
 362  */
 363 MEDCouplingMesh *MEDCouplingMesh::MergeMeshes(std::vector<const MEDCouplingMesh *>& meshes) throw(INTERP_KERNEL::Exception)
 364 {
 365   std::vector< MEDCouplingAutoRefCountObjectPtr<MEDCouplingUMesh> > ms1(meshes.size());
 366   std::vector< const MEDCouplingUMesh * > ms2(meshes.size());
 367   for(std::size_t i=0;i<meshes.size();i++)
 368     {
 369       if(meshes[i])
 370         {
 371           MEDCouplingUMesh *cur=meshes[i]->buildUnstructured();
 372           ms1[i]=cur;  ms2[i]=cur;
 373         }
 374       else
 375         {
 376           std::ostringstream oss; oss << "MEDCouplingMesh::MergeMeshes(std::vector<const MEDCouplingMesh *>& meshes) : mesh at pos #" << i << " of input vector of size " << meshes.size() << " is empty !";
 377           throw INTERP_KERNEL::Exception(oss.str().c_str());
 378         }
 379     }
 380   return MEDCouplingUMesh::MergeUMeshes(ms2);
 381 }
 382
 383 /*!
 384  * \param [in] type the geometric type for which the dimension is asked.
 385  * \return the dimension associated to the input geometric type \a type.
 386  *
 387  * \throw if type is equal to \c INTERP_KERNEL::NORM_ERROR or to an unexisting geometric type.
 388  */
 389 int MEDCouplingMesh::GetDimensionOfGeometricType(INTERP_KERNEL::NormalizedCellType type) throw(INTERP_KERNEL::Exception)
 390 {
 391   const INTERP_KERNEL::CellModel& cm=INTERP_KERNEL::CellModel::GetCellModel(type);
 392   return (int) cm.getDimension();
 393 }
 394
 395 void MEDCouplingMesh::getCellsContainingPoint(const double *pos, double eps, std::vector<int>& elts) const
 396 {
 397   int ret=getCellContainingPoint(pos,eps);
 398   elts.push_back(ret);
 399 }
 400
 401 void MEDCouplingMesh::getCellsContainingPoints(const double *pos, int nbOfPoints, double eps, std::vector<int>& elts, std::vector<int>& eltsIndex) const
 402 {
 403   eltsIndex.resize(nbOfPoints+1);
 404   eltsIndex[0]=0;
 405   elts.clear();
 406   int spaceDim=getSpaceDimension();
 407   const double *work=pos;
 408   for(int i=0;i<nbOfPoints;i++,work+=spaceDim)
 409     {
 410       int ret=getCellContainingPoint(work,eps);
 411       if(ret>=0)
 412         {
 413           elts.push_back(ret);
 414           eltsIndex[i+1]=eltsIndex[i]+1;
 415         }
 416       else
 417         eltsIndex[i+1]=eltsIndex[i];
 418     }
 419 }
 420
 421 /*!
 422  * This method writes a file in VTK format into file 'fileName'.
 423  * An exception is thrown if the file is not writable.
 424  */
 425 void MEDCouplingMesh::writeVTK(const char *fileName) const throw(INTERP_KERNEL::Exception)
 426 {
 427   std::string cda,pda;
 428   writeVTKAdvanced(fileName,cda,pda);
 429 }
 430
 431 void MEDCouplingMesh::writeVTKAdvanced(const char *fileName, const std::string& cda, const std::string& pda) const throw(INTERP_KERNEL::Exception)
 432 {
 433   std::ofstream ofs(fileName);
 434   ofs << "<VTKFile type=\""  << getVTKDataSetType() << "\" version=\"0.1\" byte_order=\"LittleEndian\">\n";
 435   writeVTKLL(ofs,cda,pda);
 436   ofs << "</VTKFile>\n";
 437   ofs.close();
 438 }