1 // Copyright (C) 2007-2014 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 // Author : Anthony Geay (CEA/DEN)
21 #include "MEDCouplingFieldDouble.hxx"
22 #include "MEDCouplingFieldTemplate.hxx"
23 #include "MEDCouplingUMesh.hxx"
24 #include "MEDCouplingTimeDiscretization.hxx"
25 #include "MEDCouplingFieldDiscretization.hxx"
26 #include "MEDCouplingAutoRefCountObjectPtr.hxx"
27 #include "MEDCouplingNatureOfField.hxx"
29 #include "InterpKernelAutoPtr.hxx"
36 using namespace ParaMEDMEM;
40 * Creates a new MEDCouplingFieldDouble, of given spatial type and time discretization.
41 * For more info, see \ref MEDCouplingFirstSteps3.
42 * \param [in] type - the type of spatial discretization of the created field, one of
43 * (\ref ParaMEDMEM::ON_CELLS "ON_CELLS",
44 * \ref ParaMEDMEM::ON_NODES "ON_NODES",
45 * \ref ParaMEDMEM::ON_GAUSS_PT "ON_GAUSS_PT",
46 * \ref ParaMEDMEM::ON_GAUSS_NE "ON_GAUSS_NE",
47 * \ref ParaMEDMEM::ON_NODES_KR "ON_NODES_KR").
48 * \param [in] td - the type of time discretization of the created field, one of
49 * (\ref ParaMEDMEM::NO_TIME "NO_TIME",
50 * \ref ParaMEDMEM::ONE_TIME "ONE_TIME",
51 * \ref ParaMEDMEM::LINEAR_TIME "LINEAR_TIME",
52 * \ref ParaMEDMEM::CONST_ON_TIME_INTERVAL "CONST_ON_TIME_INTERVAL").
53 * \return MEDCouplingFieldDouble* - a new instance of MEDCouplingFieldDouble. The
54 * caller is to delete this field using decrRef() as it is no more needed.
56 MEDCouplingFieldDouble* MEDCouplingFieldDouble::New(TypeOfField type, TypeOfTimeDiscretization td)
58 return new MEDCouplingFieldDouble(type,td);
62 * Creates a new MEDCouplingFieldDouble, of a given time discretization and with a
63 * spatial type and supporting mesh copied from a given
64 * \ref MEDCouplingFieldTemplatesPage "field template".
65 * For more info, see \ref MEDCouplingFirstSteps3.
66 * \warning This method does not deeply copy neither the mesh nor the spatial
67 * discretization. Only a shallow copy (reference) is done for the mesh and the spatial
69 * \param [in] ft - the \ref MEDCouplingFieldTemplatesPage "field template" defining
70 * the spatial discretization and the supporting mesh.
71 * \param [in] td - the type of time discretization of the created field, one of
72 * (\ref ParaMEDMEM::NO_TIME "NO_TIME",
73 * \ref ParaMEDMEM::ONE_TIME "ONE_TIME",
74 * \ref ParaMEDMEM::LINEAR_TIME "LINEAR_TIME",
75 * \ref ParaMEDMEM::CONST_ON_TIME_INTERVAL "CONST_ON_TIME_INTERVAL").
76 * \return MEDCouplingFieldDouble* - a new instance of MEDCouplingFieldDouble. The
77 * caller is to delete this field using decrRef() as it is no more needed.
79 MEDCouplingFieldDouble *MEDCouplingFieldDouble::New(const MEDCouplingFieldTemplate& ft, TypeOfTimeDiscretization td)
81 return new MEDCouplingFieldDouble(ft,td);
85 * Sets a time \a unit of \a this field. For more info, see \ref MEDCouplingFirstSteps3.
86 * \param [in] unit \a unit (string) in which time is measured.
88 void MEDCouplingFieldDouble::setTimeUnit(const std::string& unit)
90 _time_discr->setTimeUnit(unit);
94 * Returns a time unit of \a this field.
95 * \return a string describing units in which time is measured.
97 std::string MEDCouplingFieldDouble::getTimeUnit() const
99 return _time_discr->getTimeUnit();
103 * This method if possible the time information (time unit, time iteration, time unit and time value) with its support
104 * that is to say its mesh.
106 * \throw If \c this->_mesh is null an exception will be thrown. An exception will also be throw if the spatial discretization is
109 void MEDCouplingFieldDouble::synchronizeTimeWithSupport()
111 _time_discr->synchronizeTimeWith(_mesh);
115 * Returns a new MEDCouplingFieldDouble which is a copy of \a this one. The data
116 * of \a this field is copied either deep or shallow depending on \a recDeepCpy
117 * parameter. But the underlying mesh is always shallow copied.
118 * Data that can be copied either deeply or shallow are:
119 * - \ref MEDCouplingTemporalDisc "temporal discretization" data that holds array(s)
121 * - \ref MEDCouplingSpatialDisc "a spatial discretization".
123 * \c clone(false) is rather dedicated for advanced users that want to limit the amount
124 * of memory. It allows the user to perform methods like operator+(), operator*()
125 * etc. with \a this and the returned field. If the user wants to duplicate deeply the
126 * underlying mesh he should call cloneWithMesh() method or deepCpy() instead.
127 * \warning The underlying \b mesh of the returned field is **always the same**
128 * (pointer) as \a this one **whatever the value** of \a recDeepCpy parameter.
129 * \param [in] recDeepCpy - if \c true, the copy of the underlying data arrays is
130 * deep, else all data arrays of \a this field are shared by the new field.
131 * \return MEDCouplingFieldDouble * - a new instance of MEDCouplingFieldDouble. The
132 * caller is to delete this field using decrRef() as it is no more needed.
133 * \sa cloneWithMesh()
135 MEDCouplingFieldDouble *MEDCouplingFieldDouble::clone(bool recDeepCpy) const
137 return new MEDCouplingFieldDouble(*this,recDeepCpy);
141 * Returns a new MEDCouplingFieldDouble which is a copy of \a this one. The data
142 * of \a this field is copied either deep or shallow depending on \a recDeepCpy
143 * parameter. But the underlying mesh is always deep copied.
144 * Data that can be copied either deeply or shallow are:
145 * - \ref MEDCouplingTemporalDisc "temporal discretization" data that holds array(s)
147 * - \ref MEDCouplingSpatialDisc "a spatial discretization".
149 * This method behaves exactly like clone() except that here the underlying **mesh is
150 * always deeply duplicated**, whatever the value \a recDeepCpy parameter.
151 * The result of \c cloneWithMesh(true) is exactly the same as that of deepCpy().
152 * So the resulting field can not be used together with \a this one in the methods
153 * like operator+(), operator*() etc. To avoid deep copying the underlying mesh,
154 * the user can call clone().
155 * \param [in] recDeepCpy - if \c true, the copy of the underlying data arrays is
156 * deep, else all data arrays of \a this field are shared by the new field.
157 * \return MEDCouplingFieldDouble * - a new instance of MEDCouplingFieldDouble. The
158 * caller is to delete this field using decrRef() as it is no more needed.
161 MEDCouplingFieldDouble *MEDCouplingFieldDouble::cloneWithMesh(bool recDeepCpy) const
163 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=clone(recDeepCpy);
166 MEDCouplingAutoRefCountObjectPtr<MEDCouplingMesh> mCpy=_mesh->deepCpy();
173 * Returns a new MEDCouplingFieldDouble which is a deep copy of \a this one **including
175 * The result of this method is exactly the same as that of \c cloneWithMesh(true).
176 * So the resulting field can not be used together with \a this one in the methods
177 * like operator+(), operator*() etc. To avoid deep copying the underlying mesh,
178 * the user can call clone().
179 * \return MEDCouplingFieldDouble * - a new instance of MEDCouplingFieldDouble. The
180 * caller is to delete this field using decrRef() as it is no more needed.
181 * \sa cloneWithMesh()
183 MEDCouplingFieldDouble *MEDCouplingFieldDouble::deepCpy() const
185 return cloneWithMesh(true);
189 * Creates a new MEDCouplingFieldDouble of given
190 * \ref MEDCouplingTemporalDisc "temporal discretization". The result field either
191 * shares the data array(s) with \a this field, or holds a deep copy of it, depending on
192 * \a deepCopy parameter. But the underlying \b mesh is always **shallow copied**.
193 * \param [in] td - the type of time discretization of the created field, one of
194 * (\ref ParaMEDMEM::NO_TIME "NO_TIME",
195 * \ref ParaMEDMEM::ONE_TIME "ONE_TIME",
196 * \ref ParaMEDMEM::LINEAR_TIME "LINEAR_TIME",
197 * \ref ParaMEDMEM::CONST_ON_TIME_INTERVAL "CONST_ON_TIME_INTERVAL").
198 * \param [in] deepCopy - if \c true, the copy of the underlying data arrays is
199 * deep, else all data arrays of \a this field are shared by the new field.
200 * \return MEDCouplingFieldDouble* - a new instance of MEDCouplingFieldDouble. The
201 * caller is to delete this field using decrRef() as it is no more needed.
203 * \if ENABLE_EXAMPLES
204 * \ref cpp_mcfielddouble_buildNewTimeReprFromThis "Here is a C++ example."<br>
205 * \ref py_mcfielddouble_buildNewTimeReprFromThis "Here is a Python example."
209 MEDCouplingFieldDouble *MEDCouplingFieldDouble::buildNewTimeReprFromThis(TypeOfTimeDiscretization td, bool deepCopy) const
211 MEDCouplingTimeDiscretization *tdo=_time_discr->buildNewTimeReprFromThis(td,deepCopy);
212 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDiscretization> disc;
215 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),tdo,disc.retn());
216 ret->setMesh(getMesh());
217 ret->setName(getName());
218 ret->setDescription(getDescription());
223 * This method converts a field on nodes (\a this) to a cell field (returned field). The convertion is a \b non \b conservative remapping !
224 * This method is useful only for users that need a fast convertion from node to cell spatial discretization. The algorithm applied is simply to attach
225 * to each cell the average of values on nodes constituting this cell.
227 * \return MEDCouplingFieldDouble* - a new instance of MEDCouplingFieldDouble. The
228 * caller is to delete this field using decrRef() as it is no more needed. The returned field will share the same mesh object object than those in \a this.
229 * \throw If \a this spatial discretization is empty or not ON_NODES.
230 * \throw If \a this is not coherent (see MEDCouplingFieldDouble::checkCoherency).
232 * \warning This method is a \b non \b conservative method of remapping from node spatial discretization to cell spatial discretization.
233 * If a conservative method of interpolation is required ParaMEDMEM::MEDCouplingRemapper class should be used instead with "P1P0" method.
235 MEDCouplingFieldDouble *MEDCouplingFieldDouble::nodeToCellDiscretization() const
238 TypeOfField tf(getTypeOfField());
240 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::nodeToCellDiscretization : this field is expected to be on ON_NODES !");
241 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret(clone(false));
242 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDiscretizationP0> nsp(new MEDCouplingFieldDiscretizationP0);
243 ret->setDiscretization(nsp);
244 const MEDCouplingMesh *m(getMesh());//m is non empty thanks to checkCoherency call
245 int nbCells(m->getNumberOfCells());
246 std::vector<DataArrayDouble *> arrs(getArrays());
247 std::size_t sz(arrs.size());
248 std::vector< MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> > outArrsSafe(sz); std::vector<DataArrayDouble *> outArrs(sz);
249 for(std::size_t j=0;j<sz;j++)
251 int nbCompo(arrs[j]->getNumberOfComponents());
252 outArrsSafe[j]=DataArrayDouble::New(); outArrsSafe[j]->alloc(nbCells,nbCompo);
253 outArrsSafe[j]->copyStringInfoFrom(*arrs[j]);
254 outArrs[j]=outArrsSafe[j];
255 double *pt(outArrsSafe[j]->getPointer());
256 const double *srcPt(arrs[j]->begin());
257 for(int i=0;i<nbCells;i++,pt+=nbCompo)
259 std::vector<int> nodeIds;
260 m->getNodeIdsOfCell(i,nodeIds);
261 std::fill(pt,pt+nbCompo,0.);
262 std::size_t nbNodesInCell(nodeIds.size());
263 for(std::size_t k=0;k<nbNodesInCell;k++)
264 std::transform(srcPt+nodeIds[k]*nbCompo,srcPt+(nodeIds[k]+1)*nbCompo,pt,pt,std::plus<double>());
266 std::transform(pt,pt+nbCompo,pt,std::bind2nd(std::multiplies<double>(),1./((double)nbNodesInCell)));
269 std::ostringstream oss; oss << "MEDCouplingFieldDouble::nodeToCellDiscretization : Cell id #" << i << " has been detected to have no nodes !";
270 throw INTERP_KERNEL::Exception(oss.str().c_str());
274 ret->setArrays(outArrs);
279 * This method converts a field on cell (\a this) to a node field (returned field). The convertion is a \b non \b conservative remapping !
280 * This method is useful only for users that need a fast convertion from cell to node spatial discretization. The algorithm applied is simply to attach
281 * to each node the average of values on cell sharing this node. If \a this lies on a mesh having orphan nodes the values applied on them will be NaN (division by 0.).
283 * \return MEDCouplingFieldDouble* - a new instance of MEDCouplingFieldDouble. The
284 * caller is to delete this field using decrRef() as it is no more needed. The returned field will share the same mesh object object than those in \a this.
285 * \throw If \a this spatial discretization is empty or not ON_CELLS.
286 * \throw If \a this is not coherent (see MEDCouplingFieldDouble::checkCoherency).
288 * \warning This method is a \b non \b conservative method of remapping from cell spatial discretization to node spatial discretization.
289 * If a conservative method of interpolation is required ParaMEDMEM::MEDCouplingRemapper class should be used instead with "P0P1" method.
291 MEDCouplingFieldDouble *MEDCouplingFieldDouble::cellToNodeDiscretization() const
294 TypeOfField tf(getTypeOfField());
296 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::cellToNodeDiscretization : this field is expected to be on ON_CELLS !");
297 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret(clone(false));
298 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDiscretizationP1> nsp(new MEDCouplingFieldDiscretizationP1);
299 ret->setDiscretization(nsp);
300 const MEDCouplingMesh *m(getMesh());//m is non empty thanks to checkCoherency call
301 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> rn(DataArrayInt::New()),rni(DataArrayInt::New());
302 m->getReverseNodalConnectivity(rn,rni);
303 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> rni2(rni->deltaShiftIndex());
304 MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> rni3(rni2->convertToDblArr()); rni2=0;
305 std::vector<DataArrayDouble *> arrs(getArrays());
306 std::size_t sz(arrs.size());
307 std::vector< MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> > outArrsSafe(sz); std::vector<DataArrayDouble *> outArrs(sz);
308 for(std::size_t j=0;j<sz;j++)
310 MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> tmp(arrs[j]->selectByTupleIdSafe(rn->begin(),rn->end()));
311 outArrsSafe[j]=(tmp->accumulatePerChunck(rni->begin(),rni->end())); tmp=0;
312 outArrsSafe[j]->divideEqual(rni3);
313 outArrsSafe[j]->copyStringInfoFrom(*arrs[j]);
314 outArrs[j]=outArrsSafe[j];
316 ret->setArrays(outArrs);
321 * Copies tiny info (component names, name and description) from an \a other field to
323 * \warning The underlying mesh is not renamed (for safety reason).
324 * \param [in] other - the field to copy the tiny info from.
325 * \throw If \a this->getNumberOfComponents() != \a other->getNumberOfComponents()
327 void MEDCouplingFieldDouble::copyTinyStringsFrom(const MEDCouplingField *other)
329 MEDCouplingField::copyTinyStringsFrom(other);
330 const MEDCouplingFieldDouble *otherC=dynamic_cast<const MEDCouplingFieldDouble *>(other);
333 _time_discr->copyTinyStringsFrom(*otherC->_time_discr);
338 * Copies only times, order and iteration from an \a other field to
339 * \a this one. The underlying mesh is not impacted by this method.
340 * Arrays are not impacted neither.
341 * \param [in] other - the field to tiny attributes from.
342 * \throw If \a this->getNumberOfComponents() != \a other->getNumberOfComponents()
344 void MEDCouplingFieldDouble::copyTinyAttrFrom(const MEDCouplingFieldDouble *other)
348 _time_discr->copyTinyAttrFrom(*other->_time_discr);
352 void MEDCouplingFieldDouble::copyAllTinyAttrFrom(const MEDCouplingFieldDouble *other)
354 copyTinyStringsFrom(other);
355 copyTinyAttrFrom(other);
359 * Returns a string describing \a this field. This string is outputted by \c print
360 * Python command. The string includes info on
363 * - \ref MEDCouplingSpatialDisc "spatial discretization",
364 * - \ref MEDCouplingTemporalDisc "time discretization",
365 * - \ref NatureOfField,
369 * \return std::string - the string describing \a this field.
371 std::string MEDCouplingFieldDouble::simpleRepr() const
373 std::ostringstream ret;
374 ret << "FieldDouble with name : \"" << getName() << "\"\n";
375 ret << "Description of field is : \"" << getDescription() << "\"\n";
377 { ret << "FieldDouble space discretization is : " << _type->getStringRepr() << "\n"; }
379 { ret << "FieldDouble has no spatial discretization !\n"; }
381 { ret << "FieldDouble time discretization is : " << _time_discr->getStringRepr() << "\n"; }
383 { ret << "FieldDouble has no time discretization !\n"; }
384 ret << "FieldDouble nature of field is : \"" << MEDCouplingNatureOfField::GetReprNoThrow(_nature) << "\"\n";
387 if(getArray()->isAllocated())
389 int nbOfCompo=getArray()->getNumberOfComponents();
390 ret << "FieldDouble default array has " << nbOfCompo << " components and " << getArray()->getNumberOfTuples() << " tuples.\n";
391 ret << "FieldDouble default array has following info on components : ";
392 for(int i=0;i<nbOfCompo;i++)
393 ret << "\"" << getArray()->getInfoOnComponent(i) << "\" ";
398 ret << "Array set but not allocated !\n";
402 ret << "Mesh support information :\n__________________________\n" << _mesh->simpleRepr();
404 ret << "Mesh support information : No mesh set !\n";
409 * Returns a string describing \a this field. The string includes info on
412 * - \ref MEDCouplingSpatialDisc "spatial discretization",
413 * - \ref MEDCouplingTemporalDisc "time discretization",
416 * - contents of data arrays.
418 * \return std::string - the string describing \a this field.
420 std::string MEDCouplingFieldDouble::advancedRepr() const
422 std::ostringstream ret;
423 ret << "FieldDouble with name : \"" << getName() << "\"\n";
424 ret << "Description of field is : \"" << getDescription() << "\"\n";
426 { ret << "FieldDouble space discretization is : " << _type->getStringRepr() << "\n"; }
428 { ret << "FieldDouble has no space discretization set !\n"; }
430 { ret << "FieldDouble time discretization is : " << _time_discr->getStringRepr() << "\n"; }
432 { ret << "FieldDouble has no time discretization set !\n"; }
434 ret << "FieldDouble default array has " << getArray()->getNumberOfComponents() << " components and " << getArray()->getNumberOfTuples() << " tuples.\n";
436 ret << "Mesh support information :\n__________________________\n" << _mesh->advancedRepr();
438 ret << "Mesh support information : No mesh set !\n";
439 std::vector<DataArrayDouble *> arrays;
440 _time_discr->getArrays(arrays);
442 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++,arrayId++)
444 ret << "Array #" << arrayId << " :\n__________\n";
446 (*iter)->reprWithoutNameStream(ret);
448 ret << "Array empty !";
454 void MEDCouplingFieldDouble::writeVTK(const std::string& fileName, bool isBinary) const
456 std::vector<const MEDCouplingFieldDouble *> fs(1,this);
457 MEDCouplingFieldDouble::WriteVTK(fileName,fs,isBinary);
460 bool MEDCouplingFieldDouble::isEqualIfNotWhy(const MEDCouplingField *other, double meshPrec, double valsPrec, std::string& reason) const
463 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::isEqualIfNotWhy : other instance is NULL !");
464 const MEDCouplingFieldDouble *otherC=dynamic_cast<const MEDCouplingFieldDouble *>(other);
467 reason="field given in input is not castable in MEDCouplingFieldDouble !";
470 if(!MEDCouplingField::isEqualIfNotWhy(other,meshPrec,valsPrec,reason))
472 if(!_time_discr->isEqualIfNotWhy(otherC->_time_discr,valsPrec,reason))
474 reason.insert(0,"In FieldDouble time discretizations differ :");
481 * Checks equality of \a this and \a other field. Only numeric data is considered,
482 * i.e. names, description etc are not compared.
483 * \param [in] other - the field to compare with.
484 * \param [in] meshPrec - a precision used to compare node coordinates of meshes.
485 * \param [in] valsPrec - a precision used to compare data arrays of the two fields.
486 * \return bool - \c true if the two fields are equal, \c false else.
487 * \throw If \a other == NULL.
488 * \throw If the spatial discretization of \a this field is NULL.
490 bool MEDCouplingFieldDouble::isEqualWithoutConsideringStr(const MEDCouplingField *other, double meshPrec, double valsPrec) const
492 const MEDCouplingFieldDouble *otherC=dynamic_cast<const MEDCouplingFieldDouble *>(other);
495 if(!MEDCouplingField::isEqualWithoutConsideringStr(other,meshPrec,valsPrec))
497 if(!_time_discr->isEqualWithoutConsideringStr(otherC->_time_discr,valsPrec))
503 * This method states if \a this and 'other' are compatibles each other before performing any treatment.
504 * This method is good for methods like : mergeFields.
505 * This method is not very demanding compared to areStrictlyCompatible that is better for operation on fields.
507 bool MEDCouplingFieldDouble::areCompatibleForMerge(const MEDCouplingField *other) const
509 if(!MEDCouplingField::areCompatibleForMerge(other))
511 const MEDCouplingFieldDouble *otherC=dynamic_cast<const MEDCouplingFieldDouble *>(other);
514 if(!_time_discr->areCompatible(otherC->_time_discr))
520 * This method is more strict than MEDCouplingField::areCompatibleForMerge method.
521 * This method is used for operation on fields to operate a first check before attempting operation.
523 bool MEDCouplingFieldDouble::areStrictlyCompatible(const MEDCouplingField *other) const
526 if(!MEDCouplingField::areStrictlyCompatible(other))
528 const MEDCouplingFieldDouble *otherC=dynamic_cast<const MEDCouplingFieldDouble *>(other);
531 if(!_time_discr->areStrictlyCompatible(otherC->_time_discr,tmp))
537 * Method with same principle than MEDCouplingFieldDouble::areStrictlyCompatible method except that
538 * number of components between \a this and 'other' can be different here (for operator*).
540 bool MEDCouplingFieldDouble::areCompatibleForMul(const MEDCouplingField *other) const
542 if(!MEDCouplingField::areStrictlyCompatible(other))
544 const MEDCouplingFieldDouble *otherC=dynamic_cast<const MEDCouplingFieldDouble *>(other);
547 if(!_time_discr->areStrictlyCompatibleForMul(otherC->_time_discr))
553 * Method with same principle than MEDCouplingFieldDouble::areStrictlyCompatible method except that
554 * number of components between \a this and 'other' can be different here (for operator/).
556 bool MEDCouplingFieldDouble::areCompatibleForDiv(const MEDCouplingField *other) const
558 if(!MEDCouplingField::areStrictlyCompatible(other))
560 const MEDCouplingFieldDouble *otherC=dynamic_cast<const MEDCouplingFieldDouble *>(other);
563 if(!_time_discr->areStrictlyCompatibleForDiv(otherC->_time_discr))
569 * This method is invocated before any attempt of melding. This method is very close to areStrictlyCompatible,
570 * except that \a this and other can have different number of components.
572 bool MEDCouplingFieldDouble::areCompatibleForMeld(const MEDCouplingFieldDouble *other) const
574 if(!MEDCouplingField::areStrictlyCompatible(other))
576 if(!_time_discr->areCompatibleForMeld(other->_time_discr))
582 * Permutes values of \a this field according to a given permutation array for cells
583 * renumbering. The underlying mesh is deeply copied and its cells are also permuted.
584 * The number of cells remains the same; for that the permutation array \a old2NewBg
585 * should not contain equal ids.
586 * ** Warning, this method modifies the mesh aggreagated by \a this (by performing a deep copy ) **.
588 * \param [in] old2NewBg - the permutation array in "Old to New" mode. Its length is
589 * to be equal to \a this->getMesh()->getNumberOfCells().
590 * \param [in] check - if \c true, \a old2NewBg is transformed to a new permutation
591 * array, so that its maximal cell id to correspond to (be less than) the number
592 * of cells in mesh. This new array is then used for the renumbering. If \a
593 * check == \c false, \a old2NewBg is used as is, that is less secure as validity
594 * of ids in \a old2NewBg is not checked.
595 * \throw If the mesh is not set.
596 * \throw If the spatial discretization of \a this field is NULL.
597 * \throw If \a check == \c true and \a old2NewBg contains equal ids.
598 * \throw If mesh nature does not allow renumbering (e.g. structured mesh).
600 * \if ENABLE_EXAMPLES
601 * \ref cpp_mcfielddouble_renumberCells "Here is a C++ example".<br>
602 * \ref py_mcfielddouble_renumberCells "Here is a Python example".
605 void MEDCouplingFieldDouble::renumberCells(const int *old2NewBg, bool check)
607 renumberCellsWithoutMesh(old2NewBg,check);
608 MEDCouplingAutoRefCountObjectPtr<MEDCouplingMesh> m=_mesh->deepCpy();
609 m->renumberCells(old2NewBg,check);
615 * Permutes values of \a this field according to a given permutation array for cells
616 * renumbering. The underlying mesh is \b not permuted.
617 * The number of cells remains the same; for that the permutation array \a old2NewBg
618 * should not contain equal ids.
619 * This method performs a part of job of renumberCells(). The reasonable use of this
620 * method is only for multi-field instances lying on the same mesh to avoid a
621 * systematic duplication and renumbering of _mesh attribute.
622 * \warning Use this method with a lot of care!
623 * \param [in] old2NewBg - the permutation array in "Old to New" mode. Its length is
624 * to be equal to \a this->getMesh()->getNumberOfCells().
625 * \param [in] check - if \c true, \a old2NewBg is transformed to a new permutation
626 * array, so that its maximal cell id to correspond to (be less than) the number
627 * of cells in mesh. This new array is then used for the renumbering. If \a
628 * check == \c false, \a old2NewBg is used as is, that is less secure as validity
629 * of ids in \a old2NewBg is not checked.
630 * \throw If the mesh is not set.
631 * \throw If the spatial discretization of \a this field is NULL.
632 * \throw If \a check == \c true and \a old2NewBg contains equal ids.
633 * \throw If mesh nature does not allow renumbering (e.g. structured mesh).
635 void MEDCouplingFieldDouble::renumberCellsWithoutMesh(const int *old2NewBg, bool check)
638 throw INTERP_KERNEL::Exception("Expecting a defined mesh to be able to operate a renumbering !");
639 if(!((const MEDCouplingFieldDiscretization *)_type))
640 throw INTERP_KERNEL::Exception("Expecting a spatial discretization to be able to operate a renumbering !");
642 _type->renumberCells(old2NewBg,check);
643 std::vector<DataArrayDouble *> arrays;
644 _time_discr->getArrays(arrays);
645 std::vector<DataArray *> arrays2(arrays.size()); std::copy(arrays.begin(),arrays.end(),arrays2.begin());
646 _type->renumberArraysForCell(_mesh,arrays2,old2NewBg,check);
652 * Permutes values of \a this field according to a given permutation array for node
653 * renumbering. The underlying mesh is deeply copied and its nodes are also permuted.
654 * The number of nodes can change, contrary to renumberCells().
655 * \param [in] old2NewBg - the permutation array in "Old to New" mode. Its length is
656 * to be equal to \a this->getMesh()->getNumberOfNodes().
657 * \param [in] eps - a precision used to compare field values at merged nodes. If
658 * the values differ more than \a eps, an exception is thrown.
659 * \throw If the mesh is not set.
660 * \throw If the spatial discretization of \a this field is NULL.
661 * \throw If \a check == \c true and \a old2NewBg contains equal ids.
662 * \throw If mesh nature does not allow renumbering (e.g. structured mesh).
663 * \throw If values at merged nodes deffer more than \a eps.
665 * \if ENABLE_EXAMPLES
666 * \ref cpp_mcfielddouble_renumberNodes "Here is a C++ example".<br>
667 * \ref py_mcfielddouble_renumberNodes "Here is a Python example".
670 void MEDCouplingFieldDouble::renumberNodes(const int *old2NewBg, double eps)
672 const MEDCouplingPointSet *meshC=dynamic_cast<const MEDCouplingPointSet *>(_mesh);
674 throw INTERP_KERNEL::Exception("Invalid mesh to apply renumberNodes on it !");
675 int nbOfNodes=meshC->getNumberOfNodes();
676 MEDCouplingAutoRefCountObjectPtr<MEDCouplingPointSet> meshC2((MEDCouplingPointSet *)meshC->deepCpy());
677 int newNbOfNodes=*std::max_element(old2NewBg,old2NewBg+nbOfNodes)+1;
678 renumberNodesWithoutMesh(old2NewBg,newNbOfNodes,eps);
679 meshC2->renumberNodes(old2NewBg,newNbOfNodes);
684 * Permutes values of \a this field according to a given permutation array for nodes
685 * renumbering. The underlying mesh is \b not permuted.
686 * The number of nodes can change, contrary to renumberCells().
687 * A given epsilon specifies a threshold of error in case of two nodes are merged but
688 * the difference of values on these nodes are higher than \a eps.
689 * This method performs a part of job of renumberNodes(), excluding node renumbering
690 * in mesh. The reasonable use of this
691 * method is only for multi-field instances lying on the same mesh to avoid a
692 * systematic duplication and renumbering of _mesh attribute.
693 * \warning Use this method with a lot of care!
694 * \warning In case of an exception thrown, the contents of the data array can be
695 * partially modified until the exception occurs.
696 * \param [in] old2NewBg - the permutation array in "Old to New" mode. Its length is
697 * to be equal to \a this->getMesh()->getNumberOfNodes().
698 * \param [in] newNbOfNodes - a number of nodes in the mesh after renumbering.
699 * \param [in] eps - a precision used to compare field values at merged nodes. If
700 * the values differ more than \a eps, an exception is thrown.
701 * \throw If the mesh is not set.
702 * \throw If the spatial discretization of \a this field is NULL.
703 * \throw If values at merged nodes deffer more than \a eps.
705 void MEDCouplingFieldDouble::renumberNodesWithoutMesh(const int *old2NewBg, int newNbOfNodes, double eps)
707 if(!((const MEDCouplingFieldDiscretization *)_type))
708 throw INTERP_KERNEL::Exception("Expecting a spatial discretization to be able to operate a renumbering !");
709 std::vector<DataArrayDouble *> arrays;
710 _time_discr->getArrays(arrays);
711 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
713 _type->renumberValuesOnNodes(eps,old2NewBg,newNbOfNodes,*iter);
717 * Returns all tuple ids of \a this scalar field that fit the range [\a vmin,
718 * \a vmax]. This method calls DataArrayDouble::getIdsInRange().
719 * \param [in] vmin - a lower boundary of the range. Tuples with values less than \a
720 * vmin are not included in the result array.
721 * \param [in] vmax - an upper boundary of the range. Tuples with values more than \a
722 * vmax are not included in the result array.
723 * \return DataArrayInt * - a new instance of DataArrayInt holding ids of selected
724 * tuples. The caller is to delete this array using decrRef() as it is no
726 * \throw If the data array is not set.
727 * \throw If \a this->getNumberOfComponents() != 1.
729 DataArrayInt *MEDCouplingFieldDouble::getIdsInRange(double vmin, double vmax) const
732 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::getIdsInRange : no default array set !");
733 return getArray()->getIdsInRange(vmin,vmax);
737 * Builds a newly created field, that the caller will have the responsability to deal with (decrRef()).
738 * This method makes the assumption that the field is correctly defined when this method is called, no check of this will be done.
739 * 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.
740 * Parameter \a part specifies **cell ids whatever the spatial discretization of this** (
741 * \ref ParaMEDMEM::ON_CELLS "ON_CELLS",
742 * \ref ParaMEDMEM::ON_NODES "ON_NODES",
743 * \ref ParaMEDMEM::ON_GAUSS_PT "ON_GAUSS_PT",
744 * \ref ParaMEDMEM::ON_GAUSS_NE "ON_GAUSS_NE",
745 * \ref ParaMEDMEM::ON_NODES_KR "ON_NODES_KR").
747 * For example, \a this is a field on cells lying on a mesh that have 10 cells, \a part contains following cell ids [3,7,6].
748 * Then the returned field will lie on mesh having 3 cells and the returned field will contain 3 tuples.<br>
749 * Tuple #0 of the result field will refer to the cell #0 of returned mesh. The cell #0 of returned mesh will be equal to the cell #3 of \a this->getMesh().<br>
750 * Tuple #1 of the result field will refer to the cell #1 of returned mesh. The cell #1 of returned mesh will be equal to the cell #7 of \a this->getMesh().<br>
751 * Tuple #2 of the result field will refer to the cell #2 of returned mesh. The cell #2 of returned mesh will be equal to the cell #6 of \a this->getMesh().
753 * Let, for example, \a this be a field on nodes lying on a mesh that have 10 cells and 11 nodes, and \a part contains following cellIds [3,7,6].
754 * Thus \a this currently contains 11 tuples. If the restriction of mesh to 3 cells leads to a mesh with 6 nodes, then the returned field
755 * will contain 6 tuples and \a this field will lie on this restricted mesh.
757 * \param [in] part - an array of cell ids to include to the result field.
758 * \return MEDCouplingFieldDouble * - a new instance of MEDCouplingFieldDouble. The caller is to delete this field using decrRef() as it is no more needed.
760 * \if ENABLE_EXAMPLES
761 * \ref cpp_mcfielddouble_subpart1 "Here is a C++ example".<br>
762 * \ref py_mcfielddouble_subpart1 "Here is a Python example".
764 * \sa MEDCouplingFieldDouble::buildSubPartRange
767 MEDCouplingFieldDouble *MEDCouplingFieldDouble::buildSubPart(const DataArrayInt *part) const
770 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::buildSubPart : not empty array must be passed to this method !");
771 return buildSubPart(part->begin(),part->end());
775 * Builds a newly created field, that the caller will have the responsability to deal with.
776 * \n This method makes the assumption that \a this field is correctly defined when this method is called (\a this->checkCoherency() returns without any exception thrown), **no check of this will be done**.
777 * \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.
778 * \n Parameter [\a partBg, \a partEnd ) specifies **cell ids whatever the spatial discretization** of \a this (
779 * \ref ParaMEDMEM::ON_CELLS "ON_CELLS",
780 * \ref ParaMEDMEM::ON_NODES "ON_NODES",
781 * \ref ParaMEDMEM::ON_GAUSS_PT "ON_GAUSS_PT",
782 * \ref ParaMEDMEM::ON_GAUSS_NE "ON_GAUSS_NE",
783 * \ref ParaMEDMEM::ON_NODES_KR "ON_NODES_KR").
785 * For example, \a this is a field on cells lying on a mesh that have 10 cells, \a partBg contains the following cell ids [3,7,6].
786 * Then the returned field will lie on mesh having 3 cells and will contain 3 tuples.
787 *- Tuple #0 of the result field will refer to the cell #0 of returned mesh. The cell #0 of returned mesh will be equal to the cell #3 of \a this->getMesh().
788 *- Tuple #1 of the result field will refer to the cell #1 of returned mesh. The cell #1 of returned mesh will be equal to the cell #7 of \a this->getMesh().
789 *- Tuple #2 of the result field will refer to the cell #2 of returned mesh. The cell #2 of returned mesh will be equal to the cell #6 of \a this->getMesh().
791 * Let, for example, \a this be a field on nodes lying on a mesh that have 10 cells and 11 nodes, and \a partBg contains following cellIds [3,7,6].
792 * Thus \a this currently contains 11 tuples. If the restriction of mesh to 3 cells leads to a mesh with 6 nodes, then the returned field
793 * will contain 6 tuples and \a this field will lie on this restricted mesh.
795 * \param [in] partBg - start (included) of input range of cell ids to select [ \a partBg, \a partEnd )
796 * \param [in] partEnd - end (not included) of input range of cell ids to select [ \a partBg, \a partEnd )
797 * \return a newly allocated field the caller should deal with.
799 * \throw if there is presence of an invalid cell id in [ \a partBg, \a partEnd ) regarding the number of cells of \a this->getMesh().
801 * \if ENABLE_EXAMPLES
802 * \ref cpp_mcfielddouble_subpart1 "Here a C++ example."<br>
803 * \ref py_mcfielddouble_subpart1 "Here a Python example."
805 * \sa ParaMEDMEM::MEDCouplingFieldDouble::buildSubPart(const DataArrayInt *) const, MEDCouplingFieldDouble::buildSubPartRange
807 MEDCouplingFieldDouble *MEDCouplingFieldDouble::buildSubPart(const int *partBg, const int *partEnd) const
809 if(!((const MEDCouplingFieldDiscretization *)_type))
810 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::buildSubPart : Expecting a not NULL spatial discretization !");
811 DataArrayInt *arrSelect;
812 MEDCouplingAutoRefCountObjectPtr<MEDCouplingMesh> m=_type->buildSubMeshData(_mesh,partBg,partEnd,arrSelect);
813 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> arrSelect2(arrSelect);
814 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=clone(false);//quick shallow copy.
815 const MEDCouplingFieldDiscretization *disc=getDiscretization();
817 ret->setDiscretization(MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDiscretization>(disc->clonePart(partBg,partEnd)));
819 std::vector<DataArrayDouble *> arrays;
820 _time_discr->getArrays(arrays);
821 std::vector<DataArrayDouble *> arrs;
822 std::vector< MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> > arrsSafe;
823 const int *arrSelBg=arrSelect->begin();
824 const int *arrSelEnd=arrSelect->end();
825 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
827 DataArrayDouble *arr=0;
829 arr=(*iter)->selectByTupleIdSafe(arrSelBg,arrSelEnd);
830 arrs.push_back(arr); arrsSafe.push_back(arr);
832 ret->_time_discr->setArrays(arrs,0);
837 * This method is equivalent to MEDCouplingFieldDouble::buildSubPart, the only difference is that the input range of cell ids is
838 * given using a range given \a begin, \a end and \a step to optimize the part computation.
840 * \sa MEDCouplingFieldDouble::buildSubPart
842 MEDCouplingFieldDouble *MEDCouplingFieldDouble::buildSubPartRange(int begin, int end, int step) const
844 if(!((const MEDCouplingFieldDiscretization *)_type))
845 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::buildSubPart : Expecting a not NULL spatial discretization !");
846 DataArrayInt *arrSelect;
847 int beginOut,endOut,stepOut;
848 MEDCouplingAutoRefCountObjectPtr<MEDCouplingMesh> m=_type->buildSubMeshDataRange(_mesh,begin,end,step,beginOut,endOut,stepOut,arrSelect);
849 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> arrSelect2(arrSelect);
850 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=clone(false);//quick shallow copy.
851 const MEDCouplingFieldDiscretization *disc=getDiscretization();
853 ret->setDiscretization(MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDiscretization>(disc->clonePartRange(begin,end,step)));
855 std::vector<DataArrayDouble *> arrays;
856 _time_discr->getArrays(arrays);
857 std::vector<DataArrayDouble *> arrs;
858 std::vector< MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> > arrsSafe;
859 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
861 DataArrayDouble *arr=0;
866 const int *arrSelBg=arrSelect->begin();
867 const int *arrSelEnd=arrSelect->end();
868 arr=(*iter)->selectByTupleIdSafe(arrSelBg,arrSelEnd);
871 arr=(*iter)->selectByTupleId2(beginOut,endOut,stepOut);
873 arrs.push_back(arr); arrsSafe.push_back(arr);
875 ret->_time_discr->setArrays(arrs,0);
880 * Returns a type of \ref MEDCouplingTemporalDisc "time discretization" of \a this field.
881 * \return ParaMEDMEM::TypeOfTimeDiscretization - an enum item describing the time
882 * discretization type.
884 TypeOfTimeDiscretization MEDCouplingFieldDouble::getTimeDiscretization() const
886 return _time_discr->getEnum();
889 MEDCouplingFieldDouble::MEDCouplingFieldDouble(TypeOfField type, TypeOfTimeDiscretization td):MEDCouplingField(type),
890 _time_discr(MEDCouplingTimeDiscretization::New(td))
895 * ** WARINING : This method do not deeply copy neither mesh nor spatial discretization. Only a shallow copy (reference) is done for mesh and spatial discretization ! **
897 MEDCouplingFieldDouble::MEDCouplingFieldDouble(const MEDCouplingFieldTemplate& ft, TypeOfTimeDiscretization td):MEDCouplingField(ft,false),
898 _time_discr(MEDCouplingTimeDiscretization::New(td))
902 MEDCouplingFieldDouble::MEDCouplingFieldDouble(const MEDCouplingFieldDouble& other, bool deepCopy):MEDCouplingField(other,deepCopy),
903 _time_discr(other._time_discr->performCpy(deepCopy))
907 MEDCouplingFieldDouble::MEDCouplingFieldDouble(NatureOfField n, MEDCouplingTimeDiscretization *td, MEDCouplingFieldDiscretization *type):MEDCouplingField(type,n),_time_discr(td)
911 MEDCouplingFieldDouble::~MEDCouplingFieldDouble()
917 * Checks if \a this field is correctly defined, else an exception is thrown.
918 * \throw If the mesh is not set.
919 * \throw If the data array is not set.
920 * \throw If the spatial discretization of \a this field is NULL.
921 * \throw If \a this->getTimeTolerance() < 0.
922 * \throw If the temporal discretization data is incorrect.
923 * \throw If mesh data does not correspond to field data.
925 void MEDCouplingFieldDouble::checkCoherency() const
928 throw INTERP_KERNEL::Exception("Field invalid because no mesh specified !");
929 if(!((const MEDCouplingFieldDiscretization *)_type))
930 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::checkCoherency : no spatial discretization !");
931 _time_discr->checkCoherency();
932 _type->checkCoherencyBetween(_mesh,getArray());
936 * Accumulate values of a given component of \a this field.
937 * \param [in] compId - the index of the component of interest.
938 * \return double - a sum value of *compId*-th component.
939 * \throw If the data array is not set.
940 * \throw If \a the condition ( 0 <= \a compId < \a this->getNumberOfComponents() ) is
943 double MEDCouplingFieldDouble::accumulate(int compId) const
946 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::accumulate : no default array defined !");
947 return getArray()->accumulate(compId);
951 * Accumulates values of each component of \a this array.
952 * \param [out] res - an array of length \a this->getNumberOfComponents(), allocated
953 * by the caller, that is filled by this method with sum value for each
955 * \throw If the data array is not set.
957 void MEDCouplingFieldDouble::accumulate(double *res) const
960 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::accumulate : no default array defined !");
961 getArray()->accumulate(res);
965 * Returns the maximal value within \a this scalar field. Values of all arrays stored
966 * in \a this->_time_discr are checked.
967 * \return double - the maximal value among all values of \a this field.
968 * \throw If \a this->getNumberOfComponents() != 1
969 * \throw If the data array is not set.
970 * \throw If there is an empty data array in \a this field.
972 double MEDCouplingFieldDouble::getMaxValue() const
974 std::vector<DataArrayDouble *> arrays;
975 _time_discr->getArrays(arrays);
976 double ret=-std::numeric_limits<double>::max();
977 bool isExistingArr=false;
978 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
984 ret=std::max(ret,(*iter)->getMaxValue(loc));
988 throw INTERP_KERNEL::Exception("getMaxValue : No arrays defined !");
993 * Returns the maximal value and all its locations within \a this scalar field.
994 * Only the first of available data arrays is checked.
995 * \param [out] tupleIds - a new instance of DataArrayInt containg indices of
996 * tuples holding the maximal value. The caller is to delete it using
997 * decrRef() as it is no more needed.
998 * \return double - the maximal value among all values of the first array of \a this filed.
999 * \throw If \a this->getNumberOfComponents() != 1.
1000 * \throw If there is an empty data array in \a this field.
1002 double MEDCouplingFieldDouble::getMaxValue2(DataArrayInt*& tupleIds) const
1004 std::vector<DataArrayDouble *> arrays;
1005 _time_discr->getArrays(arrays);
1006 double ret=-std::numeric_limits<double>::max();
1007 bool isExistingArr=false;
1009 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> ret1;
1010 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
1016 ret=std::max(ret,(*iter)->getMaxValue2(tmp));
1017 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> tmpSafe(tmp);
1018 if(!((const DataArrayInt *)ret1))
1023 throw INTERP_KERNEL::Exception("getMaxValue2 : No arrays defined !");
1024 tupleIds=ret1.retn();
1029 * Returns the minimal value within \a this scalar field. Values of all arrays stored
1030 * in \a this->_time_discr are checked.
1031 * \return double - the minimal value among all values of \a this field.
1032 * \throw If \a this->getNumberOfComponents() != 1
1033 * \throw If the data array is not set.
1034 * \throw If there is an empty data array in \a this field.
1036 double MEDCouplingFieldDouble::getMinValue() const
1038 std::vector<DataArrayDouble *> arrays;
1039 _time_discr->getArrays(arrays);
1040 double ret=std::numeric_limits<double>::max();
1041 bool isExistingArr=false;
1042 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
1048 ret=std::min(ret,(*iter)->getMinValue(loc));
1052 throw INTERP_KERNEL::Exception("getMinValue : No arrays defined !");
1057 * Returns the minimal value and all its locations within \a this scalar field.
1058 * Only the first of available data arrays is checked.
1059 * \param [out] tupleIds - a new instance of DataArrayInt containg indices of
1060 * tuples holding the minimal value. The caller is to delete it using
1061 * decrRef() as it is no more needed.
1062 * \return double - the minimal value among all values of the first array of \a this filed.
1063 * \throw If \a this->getNumberOfComponents() != 1.
1064 * \throw If there is an empty data array in \a this field.
1066 double MEDCouplingFieldDouble::getMinValue2(DataArrayInt*& tupleIds) const
1068 std::vector<DataArrayDouble *> arrays;
1069 _time_discr->getArrays(arrays);
1070 double ret=-std::numeric_limits<double>::max();
1071 bool isExistingArr=false;
1073 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> ret1;
1074 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
1080 ret=std::max(ret,(*iter)->getMinValue2(tmp));
1081 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> tmpSafe(tmp);
1082 if(!((const DataArrayInt *)ret1))
1087 throw INTERP_KERNEL::Exception("getMinValue2 : No arrays defined !");
1088 tupleIds=ret1.retn();
1093 * Returns the average value of \a this scalar field.
1094 * \return double - the average value over all values of the data array.
1095 * \throw If \a this->getNumberOfComponents() != 1
1096 * \throw If the data array is not set or it is empty.
1098 double MEDCouplingFieldDouble::getAverageValue() const
1101 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::getAverageValue : no default array defined !");
1102 return getArray()->getAverageValue();
1106 * This method returns the euclidean norm of \a this field.
1108 * \sqrt{\sum_{0 \leq i < nbOfEntity}val[i]*val[i]}
1110 * \throw If the data array is not set.
1112 double MEDCouplingFieldDouble::norm2() const
1115 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::norm2 : no default array defined !");
1116 return getArray()->norm2();
1120 * This method returns the max norm of \a this field.
1122 * \max_{0 \leq i < nbOfEntity}{abs(val[i])}
1124 * \throw If the data array is not set.
1126 double MEDCouplingFieldDouble::normMax() const
1129 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::normMax : no default array defined !");
1130 return getArray()->normMax();
1134 * Computes sums of values of each component of \a this field wighted with
1135 * values returned by buildMeasureField().
1136 * \param [out] res - pointer to an array of result sum values, of size at least \a
1137 * this->getNumberOfComponents(), that is to be allocated by the caller.
1138 * \param [in] isWAbs - if \c true (default), \c abs() is applied to the weighs computed by
1139 * buildMeasureField() that makes this method slower. If a user is sure that all
1140 * cells of the underlying mesh have correct orientation, he can put \a isWAbs ==
1141 * \c false that speeds up this method.
1142 * \throw If the mesh is not set.
1143 * \throw If the data array is not set.
1145 void MEDCouplingFieldDouble::getWeightedAverageValue(double *res, bool isWAbs) const
1148 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::getWeightedAverageValue : no default array defined !");
1149 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> w=buildMeasureField(isWAbs);
1150 double deno=w->getArray()->accumulate(0);
1151 MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> arr=getArray()->deepCpy();
1152 arr->multiplyEqual(w->getArray());
1153 std::transform(arr->begin(),arr->end(),arr->getPointer(),std::bind2nd(std::multiplies<double>(),1./deno));
1154 arr->accumulate(res);
1158 * Computes a sum of values of a given component of \a this field wighted with
1159 * values returned by buildMeasureField().
1160 * \param [in] compId - an index of the component of interest.
1161 * \param [in] isWAbs - if \c true (default), \c abs() is applied to the weighs computed by
1162 * buildMeasureField() that makes this method slower. If a user is sure that all
1163 * cells of the underlying mesh have correct orientation, he can put \a isWAbs ==
1164 * \c false that speeds up this method.
1165 * \throw If the mesh is not set.
1166 * \throw If the data array is not set.
1167 * \throw If \a compId is not valid.
1168 A valid range is ( 0 <= \a compId < \a this->getNumberOfComponents() ).
1170 double MEDCouplingFieldDouble::getWeightedAverageValue(int compId, bool isWAbs) const
1172 int nbComps=getArray()->getNumberOfComponents();
1173 if(compId<0 || compId>=nbComps)
1175 std::ostringstream oss; oss << "MEDCouplingFieldDouble::getWeightedAverageValue : Invalid compId specified : No such nb of components ! Should be in [0," << nbComps << ") !";
1176 throw INTERP_KERNEL::Exception(oss.str().c_str());
1178 INTERP_KERNEL::AutoPtr<double> res=new double[nbComps];
1179 getWeightedAverageValue(res,isWAbs);
1184 * Returns the \c normL1 of values of a given component of \a this field:
1186 * \frac{\sum_{0 \leq i < nbOfEntity}|val[i]*Vol[i]|}{\sum_{0 \leq i < nbOfEntity}|Vol[i]|}
1188 * \param [in] compId - an index of the component of interest.
1189 * \throw If the mesh is not set.
1190 * \throw If the spatial discretization of \a this field is NULL.
1191 * \throw If \a compId is not valid.
1192 A valid range is ( 0 <= \a compId < \a this->getNumberOfComponents() ).
1194 double MEDCouplingFieldDouble::normL1(int compId) const
1197 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform normL1 !");
1198 if(!((const MEDCouplingFieldDiscretization *)_type))
1199 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform normL1 !");
1200 int nbComps=getArray()->getNumberOfComponents();
1201 if(compId<0 || compId>=nbComps)
1203 std::ostringstream oss; oss << "MEDCouplingFieldDouble::normL1 : Invalid compId specified : No such nb of components ! Should be in [0," << nbComps << ") !";
1204 throw INTERP_KERNEL::Exception(oss.str().c_str());
1206 INTERP_KERNEL::AutoPtr<double> res=new double[nbComps];
1207 _type->normL1(_mesh,getArray(),res);
1212 * Returns the \c normL1 of values of each component of \a this field:
1214 * \frac{\sum_{0 \leq i < nbOfEntity}|val[i]*Vol[i]|}{\sum_{0 \leq i < nbOfEntity}|Vol[i]|}
1216 * \param [out] res - pointer to an array of result values, of size at least \a
1217 * this->getNumberOfComponents(), that is to be allocated by the caller.
1218 * \throw If the mesh is not set.
1219 * \throw If the spatial discretization of \a this field is NULL.
1221 void MEDCouplingFieldDouble::normL1(double *res) const
1224 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform normL1");
1225 if(!((const MEDCouplingFieldDiscretization *)_type))
1226 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform normL1 !");
1227 _type->normL1(_mesh,getArray(),res);
1231 * Returns the \c normL2 of values of a given component of \a this field:
1233 * \sqrt{\frac{\sum_{0 \leq i < nbOfEntity}|val[i]^{2}*Vol[i]|}{\sum_{0 \leq i < nbOfEntity}|Vol[i]|}}
1235 * \param [in] compId - an index of the component of interest.
1236 * \throw If the mesh is not set.
1237 * \throw If the spatial discretization of \a this field is NULL.
1238 * \throw If \a compId is not valid.
1239 A valid range is ( 0 <= \a compId < \a this->getNumberOfComponents() ).
1241 double MEDCouplingFieldDouble::normL2(int compId) const
1244 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform normL2");
1245 if(!((const MEDCouplingFieldDiscretization *)_type))
1246 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform normL2 !");
1247 int nbComps=getArray()->getNumberOfComponents();
1248 if(compId<0 || compId>=nbComps)
1250 std::ostringstream oss; oss << "MEDCouplingFieldDouble::normL2 : Invalid compId specified : No such nb of components ! Should be in [0," << nbComps << ") !";
1251 throw INTERP_KERNEL::Exception(oss.str().c_str());
1253 INTERP_KERNEL::AutoPtr<double> res=new double[nbComps];
1254 _type->normL2(_mesh,getArray(),res);
1259 * Returns the \c normL2 of values of each component of \a this field:
1261 * \sqrt{\frac{\sum_{0 \leq i < nbOfEntity}|val[i]^{2}*Vol[i]|}{\sum_{0 \leq i < nbOfEntity}|Vol[i]|}}
1263 * \param [out] res - pointer to an array of result values, of size at least \a
1264 * this->getNumberOfComponents(), that is to be allocated by the caller.
1265 * \throw If the mesh is not set.
1266 * \throw If the spatial discretization of \a this field is NULL.
1268 void MEDCouplingFieldDouble::normL2(double *res) const
1271 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform normL2");
1272 if(!((const MEDCouplingFieldDiscretization *)_type))
1273 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform normL2 !");
1274 _type->normL2(_mesh,getArray(),res);
1278 * Computes a sum of values of a given component of \a this field multiplied by
1279 * values returned by buildMeasureField().
1280 * This method is useful to check the conservativity of interpolation method.
1281 * \param [in] compId - an index of the component of interest.
1282 * \param [in] isWAbs - if \c true (default), \c abs() is applied to the weighs computed by
1283 * buildMeasureField() that makes this method slower. If a user is sure that all
1284 * cells of the underlying mesh have correct orientation, he can put \a isWAbs ==
1285 * \c false that speeds up this method.
1286 * \throw If the mesh is not set.
1287 * \throw If the data array is not set.
1288 * \throw If \a compId is not valid.
1289 A valid range is ( 0 <= \a compId < \a this->getNumberOfComponents() ).
1291 double MEDCouplingFieldDouble::integral(int compId, bool isWAbs) const
1294 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform integral");
1295 if(!((const MEDCouplingFieldDiscretization *)_type))
1296 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform integral !");
1297 int nbComps=getArray()->getNumberOfComponents();
1298 if(compId<0 || compId>=nbComps)
1300 std::ostringstream oss; oss << "MEDCouplingFieldDouble::integral : Invalid compId specified : No such nb of components ! Should be in [0," << nbComps << ") !";
1301 throw INTERP_KERNEL::Exception(oss.str().c_str());
1303 INTERP_KERNEL::AutoPtr<double> res=new double[nbComps];
1304 _type->integral(_mesh,getArray(),isWAbs,res);
1309 * Computes a sum of values of each component of \a this field multiplied by
1310 * values returned by buildMeasureField().
1311 * This method is useful to check the conservativity of interpolation method.
1312 * \param [in] isWAbs - if \c true (default), \c abs() is applied to the weighs computed by
1313 * buildMeasureField() that makes this method slower. If a user is sure that all
1314 * cells of the underlying mesh have correct orientation, he can put \a isWAbs ==
1315 * \c false that speeds up this method.
1316 * \param [out] res - pointer to an array of result sum values, of size at least \a
1317 * this->getNumberOfComponents(), that is to be allocated by the caller.
1318 * \throw If the mesh is not set.
1319 * \throw If the data array is not set.
1320 * \throw If the spatial discretization of \a this field is NULL.
1322 void MEDCouplingFieldDouble::integral(bool isWAbs, double *res) const
1325 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform integral2");
1326 if(!((const MEDCouplingFieldDiscretization *)_type))
1327 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform integral2 !");
1328 _type->integral(_mesh,getArray(),isWAbs,res);
1332 * Returns a value at a given cell of a structured mesh. The cell is specified by its
1334 * \param [in] i - a index of node coordinates array along X axis. The cell is
1335 * located between the i-th and ( i + 1 )-th nodes along X axis.
1336 * \param [in] j - a index of node coordinates array along Y axis. The cell is
1337 * located between the j-th and ( j + 1 )-th nodes along Y axis.
1338 * \param [in] k - a index of node coordinates array along Z axis. The cell is
1339 * located between the k-th and ( k + 1 )-th nodes along Z axis.
1340 * \param [out] res - pointer to an array returning a feild value, of size at least
1341 * \a this->getNumberOfComponents(), that is to be allocated by the caller.
1342 * \throw If the spatial discretization of \a this field is NULL.
1343 * \throw If the mesh is not set.
1344 * \throw If the mesh is not a structured one.
1346 * \if ENABLE_EXAMPLES
1347 * \ref cpp_mcfielddouble_getValueOnPos "Here is a C++ example".<br>
1348 * \ref py_mcfielddouble_getValueOnPos "Here is a Python example".
1351 void MEDCouplingFieldDouble::getValueOnPos(int i, int j, int k, double *res) const
1353 const DataArrayDouble *arr=_time_discr->getArray();
1355 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform getValueOnPos");
1356 if(!((const MEDCouplingFieldDiscretization *)_type))
1357 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getValueOnPos !");
1358 _type->getValueOnPos(arr,_mesh,i,j,k,res);
1362 * Returns a value of \a this at a given point using spatial discretization.
1363 * \param [in] spaceLoc - the point of interest.
1364 * \param [out] res - pointer to an array returning a feild value, of size at least
1365 * \a this->getNumberOfComponents(), that is to be allocated by the caller.
1366 * \throw If the spatial discretization of \a this field is NULL.
1367 * \throw If the mesh is not set.
1368 * \throw If \a spaceLoc is out of the spatial discretization.
1370 * \if ENABLE_EXAMPLES
1371 * \ref cpp_mcfielddouble_getValueOn "Here is a C++ example".<br>
1372 * \ref py_mcfielddouble_getValueOn "Here is a Python example".
1375 void MEDCouplingFieldDouble::getValueOn(const double *spaceLoc, double *res) const
1377 const DataArrayDouble *arr=_time_discr->getArray();
1379 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform getValueOn");
1380 if(!((const MEDCouplingFieldDiscretization *)_type))
1381 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getValueOnPos !");
1382 _type->getValueOn(arr,_mesh,spaceLoc,res);
1386 * Returns values of \a this at given points using spatial discretization.
1387 * \param [in] spaceLoc - coordinates of points of interest in full-interlace
1388 * mode. This array is to be of size ( \a nbOfPoints * \a this->getNumberOfComponents() ).
1389 * \param [in] nbOfPoints - number of points of interest.
1390 * \return DataArrayDouble * - a new instance of DataArrayDouble holding field
1391 * values relating to the input points. This array is of size \a nbOfPoints
1392 * tuples per \a this->getNumberOfComponents() components. The caller is to
1393 * delete this array using decrRef() as it is no more needed.
1394 * \throw If the spatial discretization of \a this field is NULL.
1395 * \throw If the mesh is not set.
1396 * \throw If any point in \a spaceLoc is out of the spatial discretization.
1398 * \if ENABLE_EXAMPLES
1399 * \ref cpp_mcfielddouble_getValueOnMulti "Here is a C++ example".<br>
1400 * \ref py_mcfielddouble_getValueOnMulti "Here is a Python example".
1403 DataArrayDouble *MEDCouplingFieldDouble::getValueOnMulti(const double *spaceLoc, int nbOfPoints) const
1405 const DataArrayDouble *arr=_time_discr->getArray();
1407 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform getValueOnMulti");
1408 if(!((const MEDCouplingFieldDiscretization *)_type))
1409 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getValueOnMulti !");
1410 return _type->getValueOnMulti(arr,_mesh,spaceLoc,nbOfPoints);
1414 * Returns a value of \a this field at a given point at a given time using spatial discretization.
1415 * If the time is not covered by \a this->_time_discr, an exception is thrown.
1416 * \param [in] spaceLoc - the point of interest.
1417 * \param [in] time - the time of interest.
1418 * \param [out] res - pointer to an array returning a feild value, of size at least
1419 * \a this->getNumberOfComponents(), that is to be allocated by the caller.
1420 * \throw If the spatial discretization of \a this field is NULL.
1421 * \throw If the mesh is not set.
1422 * \throw If \a spaceLoc is out of the spatial discretization.
1423 * \throw If \a time is not covered by \a this->_time_discr.
1425 * \if ENABLE_EXAMPLES
1426 * \ref cpp_mcfielddouble_getValueOn_time "Here is a C++ example".<br>
1427 * \ref py_mcfielddouble_getValueOn_time "Here is a Python example".
1430 void MEDCouplingFieldDouble::getValueOn(const double *spaceLoc, double time, double *res) const
1432 std::vector< const DataArrayDouble *> arrs=_time_discr->getArraysForTime(time);
1434 throw INTERP_KERNEL::Exception("No mesh underlying this field to perform getValueOn");
1435 if(!((const MEDCouplingFieldDiscretization *)_type))
1436 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getValueOn !");
1437 std::vector<double> res2;
1438 for(std::vector< const DataArrayDouble *>::const_iterator iter=arrs.begin();iter!=arrs.end();iter++)
1440 int sz=(int)res2.size();
1441 res2.resize(sz+(*iter)->getNumberOfComponents());
1442 _type->getValueOn(*iter,_mesh,spaceLoc,&res2[sz]);
1444 _time_discr->getValueForTime(time,res2,res);
1448 * Apply a liner function to a given component of \a this field, so that
1449 * a component value <em>(x)</em> becomes \f$ a * x + b \f$.
1450 * \param [in] a - the first coefficient of the function.
1451 * \param [in] b - the second coefficient of the function.
1452 * \param [in] compoId - the index of component to modify.
1453 * \throw If the data array(s) is(are) not set.
1455 void MEDCouplingFieldDouble::applyLin(double a, double b, int compoId)
1457 _time_discr->applyLin(a,b,compoId);
1461 * This method sets \a this to a uniform scalar field with one component.
1462 * All tuples will have the same value 'value'.
1463 * An exception is thrown if no underlying mesh is defined.
1465 MEDCouplingFieldDouble &MEDCouplingFieldDouble::operator=(double value)
1468 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::operator= : no mesh defined !");
1469 if(!((const MEDCouplingFieldDiscretization *)_type))
1470 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform operator = !");
1471 int nbOfTuple=_type->getNumberOfTuples(_mesh);
1472 _time_discr->setOrCreateUniformValueOnAllComponents(nbOfTuple,value);
1477 * Creates data array(s) of \a this field by using a C function for value generation.
1478 * \param [in] nbOfComp - the number of components for \a this field to have.
1479 * \param [in] func - the function used to compute values of \a this field.
1480 * This function is to compute a field value basing on coordinates of value
1482 * \throw If the mesh is not set.
1483 * \throw If \a func returns \c false.
1484 * \throw If the spatial discretization of \a this field is NULL.
1486 * \if ENABLE_EXAMPLES
1487 * \ref cpp_mcfielddouble_fillFromAnalytic_c_func "Here is a C++ example".
1490 void MEDCouplingFieldDouble::fillFromAnalytic(int nbOfComp, FunctionToEvaluate func)
1493 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::fillFromAnalytic : no mesh defined !");
1494 if(!((const MEDCouplingFieldDiscretization *)_type))
1495 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform fillFromAnalytic !");
1496 MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> loc=_type->getLocalizationOfDiscValues(_mesh);
1497 _time_discr->fillFromAnalytic(loc,nbOfComp,func);
1501 * Creates data array(s) of \a this field by using a function for value generation.<br>
1502 * The function is applied to coordinates of value location points. For example, if
1503 * \a this field is on cells, the function is applied to cell barycenters.
1504 * For more info on supported expressions that can be used in the function, see \ref
1505 * MEDCouplingArrayApplyFuncExpr. <br>
1506 * The function can include arbitrary named variables
1507 * (e.g. "x","y" or "va44") to refer to components of point coordinates. Names of
1508 * variables are sorted in \b alphabetical \b order to associate a variable name with a
1509 * component. For example, in the expression "2*x+z", "x" stands for the component #0
1510 * and "z" stands for the component #1 (\b not #2)!<br>
1511 * In a general case, a value resulting from the function evaluation is assigned to all
1512 * components of a field value. But there is a possibility to have its own expression for
1513 * each component within one function. For this purpose, there are predefined variable
1514 * names (IVec, JVec, KVec, LVec etc) each dedicated to a certain component (IVec, to
1515 * the component #0 etc). A factor of such a variable is added to the
1516 * corresponding component only.<br>
1517 * For example, \a nbOfComp == 4, coordinates of a 3D point are (1.,3.,7.), then
1518 * - "2*x + z" produces (5.,5.,5.,5.)
1519 * - "2*x + 0*y + z" produces (9.,9.,9.,9.)
1520 * - "2*x*IVec + (x+z)*LVec" produces (2.,0.,0.,4.)
1521 * - "2*y*IVec + z*KVec + x" produces (7.,1.,1.,4.)
1523 * \param [in] nbOfComp - the number of components for \a this field to have.
1524 * \param [in] func - the function used to compute values of \a this field.
1525 * This function is used to compute a field value basing on coordinates of value
1526 * location point. For example, if \a this field is on cells, the function
1527 * is applied to cell barycenters.
1528 * \throw If the mesh is not set.
1529 * \throw If the spatial discretization of \a this field is NULL.
1530 * \throw If computing \a func fails.
1532 * \if ENABLE_EXAMPLES
1533 * \ref cpp_mcfielddouble_fillFromAnalytic "Here is a C++ example".<br>
1534 * \ref py_mcfielddouble_fillFromAnalytic "Here is a Python example".
1537 void MEDCouplingFieldDouble::fillFromAnalytic(int nbOfComp, const std::string& func)
1540 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::fillFromAnalytic : no mesh defined !");
1541 if(!((const MEDCouplingFieldDiscretization *)_type))
1542 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform fillFromAnalytic !");
1543 MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> loc=_type->getLocalizationOfDiscValues(_mesh);
1544 _time_discr->fillFromAnalytic(loc,nbOfComp,func);
1548 * Creates data array(s) of \a this field by using a function for value generation.<br>
1549 * The function is applied to coordinates of value location points. For example, if
1550 * \a this field is on cells, the function is applied to cell barycenters.<br>
1551 * This method differs from
1552 * \ref ParaMEDMEM::MEDCouplingFieldDouble::fillFromAnalytic(int nbOfComp, const std::string& func) "fillFromAnalytic()"
1553 * by the way how variable
1554 * names, used in the function, are associated with components of coordinates of field
1555 * location points; here, a variable name corresponding to a component is retrieved from
1556 * a corresponding node coordinates array (where it is set via
1557 * DataArrayDouble::setInfoOnComponent()).<br>
1558 * For more info on supported expressions that can be used in the function, see \ref
1559 * MEDCouplingArrayApplyFuncExpr. <br>
1560 * In a general case, a value resulting from the function evaluation is assigned to all
1561 * components of a field value. But there is a possibility to have its own expression for
1562 * each component within one function. For this purpose, there are predefined variable
1563 * names (IVec, JVec, KVec, LVec etc) each dedicated to a certain component (IVec, to
1564 * the component #0 etc). A factor of such a variable is added to the
1565 * corresponding component only.<br>
1566 * For example, \a nbOfComp == 4, names of spatial components are "x", "y" and "z",
1567 * coordinates of a 3D point are (1.,3.,7.), then
1568 * - "2*x + z" produces (9.,9.,9.,9.)
1569 * - "2*x*IVec + (x+z)*LVec" produces (2.,0.,0.,8.)
1570 * - "2*y*IVec + z*KVec + x" produces (7.,1.,1.,8.)
1572 * \param [in] nbOfComp - the number of components for \a this field to have.
1573 * \param [in] func - the function used to compute values of \a this field.
1574 * This function is used to compute a field value basing on coordinates of value
1575 * location point. For example, if \a this field is on cells, the function
1576 * is applied to cell barycenters.
1577 * \throw If the mesh is not set.
1578 * \throw If the spatial discretization of \a this field is NULL.
1579 * \throw If computing \a func fails.
1581 * \if ENABLE_EXAMPLES
1582 * \ref cpp_mcfielddouble_fillFromAnalytic2 "Here is a C++ example".<br>
1583 * \ref py_mcfielddouble_fillFromAnalytic2 "Here is a Python example".
1586 void MEDCouplingFieldDouble::fillFromAnalytic2(int nbOfComp, const std::string& func)
1589 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::fillFromAnalytic2 : no mesh defined !");
1590 if(!((const MEDCouplingFieldDiscretization *)_type))
1591 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform fillFromAnalytic2 !");
1592 MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> loc=_type->getLocalizationOfDiscValues(_mesh);
1593 _time_discr->fillFromAnalytic2(loc,nbOfComp,func);
1597 * Creates data array(s) of \a this field by using a function for value generation.<br>
1598 * The function is applied to coordinates of value location points. For example, if
1599 * \a this field is on cells, the function is applied to cell barycenters.<br>
1600 * This method differs from
1601 * \ref ParaMEDMEM::MEDCouplingFieldDouble::fillFromAnalytic(int nbOfComp, const std::string& func) "fillFromAnalytic()"
1602 * by the way how variable
1603 * names, used in the function, are associated with components of coordinates of field
1604 * location points; here, a component index of a variable is defined by a
1605 * rank of the variable within the input array \a varsOrder.<br>
1606 * For more info on supported expressions that can be used in the function, see \ref
1607 * MEDCouplingArrayApplyFuncExpr.
1608 * In a general case, a value resulting from the function evaluation is assigned to all
1609 * components of a field value. But there is a possibility to have its own expression for
1610 * each component within one function. For this purpose, there are predefined variable
1611 * names (IVec, JVec, KVec, LVec etc) each dedicated to a certain component (IVec, to
1612 * the component #0 etc). A factor of such a variable is added to the
1613 * corresponding component only.<br>
1614 * For example, \a nbOfComp == 4, names of
1615 * spatial components are given in \a varsOrder: ["x", "y","z"], coordinates of a
1616 * 3D point are (1.,3.,7.), then
1617 * - "2*x + z" produces (9.,9.,9.,9.)
1618 * - "2*x*IVec + (x+z)*LVec" produces (2.,0.,0.,8.)
1619 * - "2*y*IVec + z*KVec + x" produces (7.,1.,1.,8.)
1621 * \param [in] nbOfComp - the number of components for \a this field to have.
1622 * \param [in] func - the function used to compute values of \a this field.
1623 * This function is used to compute a field value basing on coordinates of value
1624 * location point. For example, if \a this field is on cells, the function
1625 * is applied to cell barycenters.
1626 * \throw If the mesh is not set.
1627 * \throw If the spatial discretization of \a this field is NULL.
1628 * \throw If computing \a func fails.
1630 * \if ENABLE_EXAMPLES
1631 * \ref cpp_mcfielddouble_fillFromAnalytic3 "Here is a C++ example".<br>
1632 * \ref py_mcfielddouble_fillFromAnalytic3 "Here is a Python example".
1635 void MEDCouplingFieldDouble::fillFromAnalytic3(int nbOfComp, const std::vector<std::string>& varsOrder, const std::string& func)
1638 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::fillFromAnalytic2 : no mesh defined !");
1639 if(!((const MEDCouplingFieldDiscretization *)_type))
1640 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform fillFromAnalytic3 !");
1641 MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> loc=_type->getLocalizationOfDiscValues(_mesh);
1642 _time_discr->fillFromAnalytic3(loc,nbOfComp,varsOrder,func);
1646 * Modifies values of \a this field by applying a C function to each tuple of all
1648 * \param [in] nbOfComp - the number of components for \a this field to have.
1649 * \param [in] func - the function used to compute values of \a this field.
1650 * This function is to compute a field value basing on a current field value.
1651 * \throw If \a func returns \c false.
1653 * \if ENABLE_EXAMPLES
1654 * \ref cpp_mcfielddouble_applyFunc_c_func "Here is a C++ example".
1657 void MEDCouplingFieldDouble::applyFunc(int nbOfComp, FunctionToEvaluate func)
1659 _time_discr->applyFunc(nbOfComp,func);
1663 * Fill \a this field with a given value.<br>
1664 * This method is a specialization of other overloaded methods. When \a nbOfComp == 1
1665 * this method is equivalent to ParaMEDMEM::MEDCouplingFieldDouble::operator=().
1666 * \param [in] nbOfComp - the number of components for \a this field to have.
1667 * \param [in] val - the value to assign to every atomic value of \a this field.
1668 * \throw If the spatial discretization of \a this field is NULL.
1669 * \throw If the mesh is not set.
1671 * \if ENABLE_EXAMPLES
1672 * \ref cpp_mcfielddouble_applyFunc_val "Here is a C++ example".<br>
1673 * \ref py_mcfielddouble_applyFunc_val "Here is a Python example".
1676 void MEDCouplingFieldDouble::applyFunc(int nbOfComp, double val)
1679 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::applyFunc : no mesh defined !");
1680 if(!((const MEDCouplingFieldDiscretization *)_type))
1681 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform applyFunc !");
1682 int nbOfTuple=_type->getNumberOfTuples(_mesh);
1683 _time_discr->setUniformValue(nbOfTuple,nbOfComp,val);
1687 * Modifies values of \a this field by applying a function to each tuple of all
1689 * For more info on supported expressions that can be used in the function, see \ref
1690 * MEDCouplingArrayApplyFuncExpr. <br>
1691 * The function can include arbitrary named variables
1692 * (e.g. "x","y" or "va44") to refer to components of a field value. Names of
1693 * variables are sorted in \b alphabetical \b order to associate a variable name with a
1694 * component. For example, in the expression "2*x+z", "x" stands for the component #0
1695 * and "z" stands for the component #1 (\b not #2)!<br>
1696 * In a general case, a value resulting from the function evaluation is assigned to all
1697 * components of a field value. But there is a possibility to have its own expression for
1698 * each component within one function. For this purpose, there are predefined variable
1699 * names (IVec, JVec, KVec, LVec etc) each dedicated to a certain component (IVec, to
1700 * the component #0 etc). A factor of such a variable is added to the
1701 * corresponding component only.<br>
1702 * For example, \a nbOfComp == 4, components of a field value are (1.,3.,7.), then
1703 * - "2*x + z" produces (5.,5.,5.,5.)
1704 * - "2*x + 0*y + z" produces (9.,9.,9.,9.)
1705 * - "2*x*IVec + (x+z)*LVec" produces (2.,0.,0.,4.)
1706 * - "2*y*IVec + z*KVec + x" produces (7.,1.,1.,4.)
1708 * \param [in] nbOfComp - the number of components for \a this field to have.
1709 * \param [in] func - the function used to compute values of \a this field.
1710 * This function is to compute a field value basing on a current field value.
1711 * \throw If computing \a func fails.
1713 * \if ENABLE_EXAMPLES
1714 * \ref cpp_mcfielddouble_applyFunc "Here is a C++ example".<br>
1715 * \ref py_mcfielddouble_applyFunc "Here is a Python example".
1718 void MEDCouplingFieldDouble::applyFunc(int nbOfComp, const std::string& func)
1720 _time_discr->applyFunc(nbOfComp,func);
1725 * Modifies values of \a this field by applying a function to each tuple of all
1727 * For more info on supported expressions that can be used in the function, see \ref
1728 * MEDCouplingArrayApplyFuncExpr. <br>
1729 * This method differs from
1730 * \ref ParaMEDMEM::MEDCouplingFieldDouble::applyFunc(int nbOfComp, const std::string& func) "applyFunc()"
1731 * by the way how variable
1732 * names, used in the function, are associated with components of field values;
1733 * here, a variable name corresponding to a component is retrieved from
1734 * component information of an array (where it is set via
1735 * DataArrayDouble::setInfoOnComponent()).<br>
1736 * In a general case, a value resulting from the function evaluation is assigned to all
1737 * components of a field value. But there is a possibility to have its own expression for
1738 * each component within one function. For this purpose, there are predefined variable
1739 * names (IVec, JVec, KVec, LVec etc) each dedicated to a certain component (IVec, to
1740 * the component #0 etc). A factor of such a variable is added to the
1741 * corresponding component only.<br>
1742 * For example, \a nbOfComp == 4, components of a field value are (1.,3.,7.), then
1743 * - "2*x + z" produces (5.,5.,5.,5.)
1744 * - "2*x + 0*y + z" produces (9.,9.,9.,9.)
1745 * - "2*x*IVec + (x+z)*LVec" produces (2.,0.,0.,4.)
1746 * - "2*y*IVec + z*KVec + x" produces (7.,1.,1.,4.)
1748 * \param [in] nbOfComp - the number of components for \a this field to have.
1749 * \param [in] func - the function used to compute values of \a this field.
1750 * This function is to compute a new field value basing on a current field value.
1751 * \throw If computing \a func fails.
1753 * \if ENABLE_EXAMPLES
1754 * \ref cpp_mcfielddouble_applyFunc2 "Here is a C++ example".<br>
1755 * \ref py_mcfielddouble_applyFunc2 "Here is a Python example".
1758 void MEDCouplingFieldDouble::applyFunc2(int nbOfComp, const std::string& func)
1760 _time_discr->applyFunc2(nbOfComp,func);
1764 * Modifies values of \a this field by applying a function to each tuple of all
1766 * This method differs from
1767 * \ref ParaMEDMEM::MEDCouplingFieldDouble::applyFunc(int nbOfComp, const std::string& func) "applyFunc()"
1768 * by the way how variable
1769 * names, used in the function, are associated with components of field values;
1770 * here, a component index of a variable is defined by a
1771 * rank of the variable within the input array \a varsOrder.<br>
1772 * For more info on supported expressions that can be used in the function, see \ref
1773 * MEDCouplingArrayApplyFuncExpr.
1774 * In a general case, a value resulting from the function evaluation is assigned to all
1775 * components of a field value. But there is a possibility to have its own expression for
1776 * each component within one function. For this purpose, there are predefined variable
1777 * names (IVec, JVec, KVec, LVec etc) each dedicated to a certain component (IVec, to
1778 * the component #0 etc). A factor of such a variable is added to the
1779 * corresponding component only.<br>
1780 * For example, \a nbOfComp == 4, names of
1781 * components are given in \a varsOrder: ["x", "y","z"], components of a
1782 * 3D vector are (1.,3.,7.), then
1783 * - "2*x + z" produces (9.,9.,9.,9.)
1784 * - "2*x*IVec + (x+z)*LVec" produces (2.,0.,0.,8.)
1785 * - "2*y*IVec + z*KVec + x" produces (7.,1.,1.,8.)
1787 * \param [in] nbOfComp - the number of components for \a this field to have.
1788 * \param [in] func - the function used to compute values of \a this field.
1789 * This function is to compute a new field value basing on a current field value.
1790 * \throw If computing \a func fails.
1792 * \if ENABLE_EXAMPLES
1793 * \ref cpp_mcfielddouble_applyFunc3 "Here is a C++ example".<br>
1794 * \ref py_mcfielddouble_applyFunc3 "Here is a Python example".
1797 void MEDCouplingFieldDouble::applyFunc3(int nbOfComp, const std::vector<std::string>& varsOrder, const std::string& func)
1799 _time_discr->applyFunc3(nbOfComp,varsOrder,func);
1803 * Modifies values of \a this field by applying a function to each atomic value of all
1804 * data arrays. The function computes a new single value basing on an old single value.
1805 * For more info on supported expressions that can be used in the function, see \ref
1806 * MEDCouplingArrayApplyFuncExpr. <br>
1807 * The function can include **only one** arbitrary named variable
1808 * (e.g. "x","y" or "va44") to refer to a field atomic value. <br>
1809 * In a general case, a value resulting from the function evaluation is assigned to
1810 * a single field value. But there is a possibility to have its own expression for
1811 * each component within one function. For this purpose, there are predefined variable
1812 * names (IVec, JVec, KVec, LVec etc) each dedicated to a certain component (IVec, to
1813 * the component #0 etc). A factor of such a variable is added to the
1814 * corresponding component only.<br>
1815 * For example, components of a field value are (1.,3.,7.), then
1816 * - "2*x - 1" produces (1.,5.,13.)
1817 * - "2*x*IVec + (x+3)*KVec" produces (2.,0.,10.)
1818 * - "2*x*IVec + (x+3)*KVec + 1" produces (3.,1.,11.)
1820 * \param [in] func - the function used to compute values of \a this field.
1821 * This function is to compute a field value basing on a current field value.
1822 * \throw If computing \a func fails.
1824 * \if ENABLE_EXAMPLES
1825 * \ref cpp_mcfielddouble_applyFunc_same_nb_comp "Here is a C++ example".<br>
1826 * \ref py_mcfielddouble_applyFunc_same_nb_comp "Here is a Python example".
1829 void MEDCouplingFieldDouble::applyFunc(const std::string& func)
1831 _time_discr->applyFunc(func);
1835 * Applyies the function specified by the string repr 'func' on each tuples on all arrays contained in _time_discr.
1836 * The field will contain exactly the same number of components after the call.
1837 * Use is not warranted for the moment !
1839 void MEDCouplingFieldDouble::applyFuncFast32(const std::string& func)
1841 _time_discr->applyFuncFast32(func);
1845 * Applyies the function specified by the string repr 'func' on each tuples on all arrays contained in _time_discr.
1846 * The field will contain exactly the same number of components after the call.
1847 * Use is not warranted for the moment !
1849 void MEDCouplingFieldDouble::applyFuncFast64(const std::string& func)
1851 _time_discr->applyFuncFast64(func);
1855 * Returns number of components in the data array. For more info on the data arrays,
1856 * see \ref MEDCouplingArrayPage.
1857 * \return int - the number of components in the data array.
1858 * \throw If the data array is not set.
1860 int MEDCouplingFieldDouble::getNumberOfComponents() const
1863 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::getNumberOfComponents : No array specified !");
1864 return getArray()->getNumberOfComponents();
1868 * Returns number of tuples in \a this field, that depends on
1869 * - the number of entities in the underlying mesh
1870 * - \ref MEDCouplingSpatialDisc "spatial discretization" of \a this field (e.g. number
1871 * of Gauss points if \a this->getTypeOfField() ==
1872 * \ref ParaMEDMEM::ON_GAUSS_PT "ON_GAUSS_PT").
1874 * The returned value does **not depend** on the number of tuples in the data array
1875 * (which has to be equal to the returned value), \b contrary to
1876 * getNumberOfComponents() and getNumberOfValues() that retrieve information from the
1878 * \warning No checkCoherency() is done here.
1879 * For more info on the data arrays, see \ref MEDCouplingArrayPage.
1880 * \return int - the number of tuples.
1881 * \throw If the mesh is not set.
1882 * \throw If the spatial discretization of \a this field is NULL.
1883 * \throw If the spatial discretization is not fully defined.
1885 int MEDCouplingFieldDouble::getNumberOfTuples() const
1888 throw INTERP_KERNEL::Exception("Impossible to retrieve number of tuples because no mesh specified !");
1889 if(!((const MEDCouplingFieldDiscretization *)_type))
1890 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getNumberOfTuples !");
1891 return _type->getNumberOfTuples(_mesh);
1895 * Returns number of atomic double values in the data array of \a this field.
1896 * For more info on the data arrays, see \ref MEDCouplingArrayPage.
1897 * \return int - (number of tuples) * (number of components) of the
1899 * \throw If the data array is not set.
1901 int MEDCouplingFieldDouble::getNumberOfValues() const
1904 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::getNumberOfValues : No array specified !");
1905 return getArray()->getNbOfElems();
1909 * Sets own modification time by the most recently modified element of data (the mesh,
1910 * the data array etc). For more info, see \ref MEDCouplingTimeLabelPage.
1912 void MEDCouplingFieldDouble::updateTime() const
1914 MEDCouplingField::updateTime();
1915 updateTimeWith(*_time_discr);
1918 std::size_t MEDCouplingFieldDouble::getHeapMemorySizeWithoutChildren() const
1920 return MEDCouplingField::getHeapMemorySizeWithoutChildren();
1923 std::vector<const BigMemoryObject *> MEDCouplingFieldDouble::getDirectChildren() const
1925 std::vector<const BigMemoryObject *> ret(MEDCouplingField::getDirectChildren());
1928 std::vector<const BigMemoryObject *> ret2(_time_discr->getDirectChildren());
1929 ret.insert(ret.end(),ret2.begin(),ret2.end());
1935 * Sets \ref NatureOfField.
1936 * \param [in] nat - an item of enum ParaMEDMEM::NatureOfField.
1938 void MEDCouplingFieldDouble::setNature(NatureOfField nat)
1940 MEDCouplingField::setNature(nat);
1942 _type->checkCompatibilityWithNature(nat);
1946 * This method synchronizes time information (time, iteration, order, time unit) regarding the information in \c this->_mesh.
1947 * \throw If no mesh is set in this. Or if \a this is not compatible with time setting (typically NO_TIME)
1949 void MEDCouplingFieldDouble::synchronizeTimeWithMesh()
1952 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::synchronizeTimeWithMesh : no mesh set in this !");
1954 double val=_mesh->getTime(it,ordr);
1955 std::string timeUnit(_mesh->getTimeUnit());
1956 setTime(val,it,ordr);
1957 setTimeUnit(timeUnit);
1961 * Returns a value of \a this field of type either
1962 * \ref ParaMEDMEM::ON_GAUSS_PT "ON_GAUSS_PT" or
1963 * \ref ParaMEDMEM::ON_GAUSS_NE "ON_GAUSS_NE".
1964 * \param [in] cellId - an id of cell of interest.
1965 * \param [in] nodeIdInCell - a node index within the cell.
1966 * \param [in] compoId - an index of component.
1967 * \return double - the field value corresponding to the specified parameters.
1968 * \throw If the data array is not set.
1969 * \throw If the mesh is not set.
1970 * \throw If the spatial discretization of \a this field is NULL.
1971 * \throw If \a this field if of type other than
1972 * \ref ParaMEDMEM::ON_GAUSS_PT "ON_GAUSS_PT" or
1973 * \ref ParaMEDMEM::ON_GAUSS_NE "ON_GAUSS_NE".
1975 double MEDCouplingFieldDouble::getIJK(int cellId, int nodeIdInCell, int compoId) const
1977 if(!((const MEDCouplingFieldDiscretization *)_type))
1978 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getIJK !");
1979 return _type->getIJK(_mesh,getArray(),cellId,nodeIdInCell,compoId);
1983 * Sets the data array.
1984 * \param [in] array - the data array holding values of \a this field. It's size
1985 * should correspond to the mesh and
1986 * \ref MEDCouplingSpatialDisc "spatial discretization" of \a this field
1987 * (see getNumberOfTuples()), but this size is not checked here.
1989 void MEDCouplingFieldDouble::setArray(DataArrayDouble *array)
1991 _time_discr->setArray(array,this);
1995 * Sets the data array holding values corresponding to an end of a time interval
1996 * for which \a this field is defined.
1997 * \param [in] array - the data array holding values of \a this field. It's size
1998 * should correspond to the mesh and
1999 * \ref MEDCouplingSpatialDisc "spatial discretization" of \a this field
2000 * (see getNumberOfTuples()), but this size is not checked here.
2002 void MEDCouplingFieldDouble::setEndArray(DataArrayDouble *array)
2004 _time_discr->setEndArray(array,this);
2008 * Sets all data arrays needed to define the field values.
2009 * \param [in] arrs - a vector of DataArrayDouble's holding values of \a this
2010 * field. Size of each array should correspond to the mesh and
2011 * \ref MEDCouplingSpatialDisc "spatial discretization" of \a this field
2012 * (see getNumberOfTuples()), but this size is not checked here.
2013 * \throw If number of arrays in \a arrs does not correspond to type of
2014 * \ref MEDCouplingTemporalDisc "temporal discretization" of \a this field.
2016 void MEDCouplingFieldDouble::setArrays(const std::vector<DataArrayDouble *>& arrs)
2018 _time_discr->setArrays(arrs,this);
2021 void MEDCouplingFieldDouble::getTinySerializationStrInformation(std::vector<std::string>& tinyInfo) const
2024 _time_discr->getTinySerializationStrInformation(tinyInfo);
2025 tinyInfo.push_back(_name);
2026 tinyInfo.push_back(_desc);
2027 tinyInfo.push_back(getTimeUnit());
2031 * This method retrieves some critical values to resize and prepare remote instance.
2032 * The first two elements returned in tinyInfo correspond to the parameters to give in constructor.
2033 * @param tinyInfo out parameter resized correctly after the call. The length of this vector is tiny.
2035 void MEDCouplingFieldDouble::getTinySerializationIntInformation(std::vector<int>& tinyInfo) const
2037 if(!((const MEDCouplingFieldDiscretization *)_type))
2038 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getTinySerializationIntInformation !");
2040 tinyInfo.push_back((int)_type->getEnum());
2041 tinyInfo.push_back((int)_time_discr->getEnum());
2042 tinyInfo.push_back((int)_nature);
2043 _time_discr->getTinySerializationIntInformation(tinyInfo);
2044 std::vector<int> tinyInfo2;
2045 _type->getTinySerializationIntInformation(tinyInfo2);
2046 tinyInfo.insert(tinyInfo.end(),tinyInfo2.begin(),tinyInfo2.end());
2047 tinyInfo.push_back((int)tinyInfo2.size());
2051 * This method retrieves some critical values to resize and prepare remote instance.
2052 * @param tinyInfo out parameter resized correctly after the call. The length of this vector is tiny.
2054 void MEDCouplingFieldDouble::getTinySerializationDbleInformation(std::vector<double>& tinyInfo) const
2056 if(!((const MEDCouplingFieldDiscretization *)_type))
2057 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform getTinySerializationDbleInformation !");
2059 _time_discr->getTinySerializationDbleInformation(tinyInfo);
2060 std::vector<double> tinyInfo2;
2061 _type->getTinySerializationDbleInformation(tinyInfo2);
2062 tinyInfo.insert(tinyInfo.end(),tinyInfo2.begin(),tinyInfo2.end());
2063 tinyInfo.push_back((int)tinyInfo2.size());//very bad, lack of time to improve it
2067 * This method has to be called to the new instance filled by CORBA, MPI, File...
2068 * @param tinyInfoI is the value retrieves from distant result of getTinySerializationIntInformation on source instance to be copied.
2069 * @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.
2070 * @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.
2071 * No decrRef must be applied to every instances in returned vector.
2073 void MEDCouplingFieldDouble::resizeForUnserialization(const std::vector<int>& tinyInfoI, DataArrayInt *&dataInt, std::vector<DataArrayDouble *>& arrays)
2075 if(!((const MEDCouplingFieldDiscretization *)_type))
2076 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform resizeForUnserialization !");
2078 std::vector<int> tinyInfoITmp(tinyInfoI);
2079 int sz=tinyInfoITmp.back();
2080 tinyInfoITmp.pop_back();
2081 std::vector<int> tinyInfoITmp2(tinyInfoITmp.begin(),tinyInfoITmp.end()-sz);
2082 std::vector<int> tinyInfoI2(tinyInfoITmp2.begin()+3,tinyInfoITmp2.end());
2083 _time_discr->resizeForUnserialization(tinyInfoI2,arrays);
2084 std::vector<int> tinyInfoITmp3(tinyInfoITmp.end()-sz,tinyInfoITmp.end());
2085 _type->resizeForUnserialization(tinyInfoITmp3,dataInt);
2088 void MEDCouplingFieldDouble::finishUnserialization(const std::vector<int>& tinyInfoI, const std::vector<double>& tinyInfoD, const std::vector<std::string>& tinyInfoS)
2090 if(!((const MEDCouplingFieldDiscretization *)_type))
2091 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform finishUnserialization !");
2092 std::vector<int> tinyInfoI2(tinyInfoI.begin()+3,tinyInfoI.end());
2094 std::vector<double> tmp(tinyInfoD);
2095 int sz=(int)tinyInfoD.back();//very bad, lack of time to improve it
2097 std::vector<double> tmp1(tmp.begin(),tmp.end()-sz);
2098 std::vector<double> tmp2(tmp.end()-sz,tmp.end());
2100 _time_discr->finishUnserialization(tinyInfoI2,tmp1,tinyInfoS);
2101 _nature=(NatureOfField)tinyInfoI[2];
2102 _type->finishUnserialization(tmp2);
2103 int nbOfElemS=(int)tinyInfoS.size();
2104 _name=tinyInfoS[nbOfElemS-3];
2105 _desc=tinyInfoS[nbOfElemS-2];
2106 setTimeUnit(tinyInfoS[nbOfElemS-1]);
2110 * Contrary to MEDCouplingPointSet class the returned arrays are \b not the responsabilities of the caller.
2111 * The values returned must be consulted only in readonly mode.
2113 void MEDCouplingFieldDouble::serialize(DataArrayInt *&dataInt, std::vector<DataArrayDouble *>& arrays) const
2115 if(!((const MEDCouplingFieldDiscretization *)_type))
2116 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform serialize !");
2117 _time_discr->getArrays(arrays);
2118 _type->getSerializationIntArray(dataInt);
2122 * Tries to set an \a other mesh as the support of \a this field. An attempt fails, if
2123 * a current and the \a other meshes are different with use of specified equality
2124 * criteria, and then an exception is thrown.
2125 * \param [in] other - the mesh to use as the field support if this mesh can be
2126 * considered equal to the current mesh.
2127 * \param [in] levOfCheck - defines equality criteria used for mesh comparison. For
2128 * it's meaning explanation, see MEDCouplingMesh::checkGeoEquivalWith() which
2129 * is used for mesh comparison.
2130 * \param [in] precOnMesh - a precision used to compare nodes of the two meshes.
2131 * It is used as \a prec parameter of MEDCouplingMesh::checkGeoEquivalWith().
2132 * \param [in] eps - a precision used at node renumbering (if needed) to compare field
2133 * values at merged nodes. If the values differ more than \a eps, an
2134 * exception is thrown.
2135 * \throw If the mesh is not set.
2136 * \throw If \a other == NULL.
2137 * \throw If any of the meshes is not well defined.
2138 * \throw If the two meshes do not match.
2139 * \throw If field values at merged nodes (if any) deffer more than \a eps.
2141 * \if ENABLE_EXAMPLES
2142 * \ref cpp_mcfielddouble_changeUnderlyingMesh "Here is a C++ example".<br>
2143 * \ref py_mcfielddouble_changeUnderlyingMesh "Here is a Python example".
2146 void MEDCouplingFieldDouble::changeUnderlyingMesh(const MEDCouplingMesh *other, int levOfCheck, double precOnMesh, double eps)
2148 if(_mesh==0 || other==0)
2149 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::changeUnderlyingMesh : is expected to operate on not null meshes !");
2150 DataArrayInt *cellCor=0,*nodeCor=0;
2151 other->checkGeoEquivalWith(_mesh,levOfCheck,precOnMesh,cellCor,nodeCor);
2152 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> cellCor2(cellCor),nodeCor2(nodeCor);
2154 renumberCellsWithoutMesh(cellCor->getConstPointer(),false);
2156 renumberNodesWithoutMesh(nodeCor->getConstPointer(),nodeCor->getMaxValueInArray()+1,eps);
2161 * Subtracts another field from \a this one in case when the two fields have different
2162 * supporting meshes. The subtraction is performed provided that the tho meshes can be
2163 * considered equal with use of specified equality criteria, else an exception is thrown.
2164 * If the meshes match, the mesh of \a f is set to \a this field (\a this is permuted if
2165 * necessary) and field values are subtracted. No interpolation is done here, only an
2166 * analysis of two underlying mesh is done to see if the meshes are geometrically
2168 * The job of this method consists in calling
2169 * \a this->changeUnderlyingMesh() with \a f->getMesh() as the first parameter, and then
2170 * \a this -= \a f.<br>
2171 * This method requires that \a f and \a this are coherent (checkCoherency()) and that \a f
2172 * and \a this are coherent for a merge.<br>
2173 * "DM" in the method name stands for "different meshes".
2174 * \param [in] f - the field to subtract from this.
2175 * \param [in] levOfCheck - defines equality criteria used for mesh comparison. For
2176 * it's meaning explanation, see MEDCouplingMesh::checkGeoEquivalWith() which
2177 * is used for mesh comparison.
2178 * \param [in] precOnMesh - a precision used to compare nodes of the two meshes.
2179 * It is used as \a prec parameter of MEDCouplingMesh::checkGeoEquivalWith().
2180 * \param [in] eps - a precision used at node renumbering (if needed) to compare field
2181 * values at merged nodes. If the values differ more than \a eps, an
2182 * exception is thrown.
2183 * \throw If \a f == NULL.
2184 * \throw If any of the meshes is not set or is not well defined.
2185 * \throw If the two meshes do not match.
2186 * \throw If the two fields are not coherent for merge.
2187 * \throw If field values at merged nodes (if any) deffer more than \a eps.
2189 * \if ENABLE_EXAMPLES
2190 * \ref cpp_mcfielddouble_substractInPlaceDM "Here is a C++ example".<br>
2191 * \ref py_mcfielddouble_substractInPlaceDM "Here is a Python example".
2193 * \sa changeUnderlyingMesh().
2195 void MEDCouplingFieldDouble::substractInPlaceDM(const MEDCouplingFieldDouble *f, int levOfCheck, double precOnMesh, double eps)
2199 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::substractInPlaceDM : input field is NULL !");
2200 f->checkCoherency();
2201 if(!areCompatibleForMerge(f))
2202 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::substractInPlaceDM : Fields are not compatible ; unable to apply mergeFields on them !");
2203 changeUnderlyingMesh(f->getMesh(),levOfCheck,precOnMesh,eps);
2208 * Merges coincident nodes of the underlying mesh. If some nodes are coincident, the
2209 * underlying mesh is replaced by a new mesh instance where the coincident nodes are merged.
2210 * \param [in] eps - a precision used to compare nodes of the two meshes.
2211 * \param [in] epsOnVals - a precision used to compare field
2212 * values at merged nodes. If the values differ more than \a epsOnVals, an
2213 * exception is thrown.
2214 * \return bool - \c true if some nodes have been merged and hence \a this field lies
2216 * \throw If the mesh is of type not inheriting from MEDCouplingPointSet.
2217 * \throw If the mesh is not well defined.
2218 * \throw If the spatial discretization of \a this field is NULL.
2219 * \throw If the data array is not set.
2220 * \throw If field values at merged nodes (if any) deffer more than \a epsOnVals.
2222 bool MEDCouplingFieldDouble::mergeNodes(double eps, double epsOnVals)
2224 const MEDCouplingPointSet *meshC=dynamic_cast<const MEDCouplingPointSet *>(_mesh);
2226 throw INTERP_KERNEL::Exception("Invalid support mesh to apply mergeNodes on it : must be a MEDCouplingPointSet one !");
2227 if(!((const MEDCouplingFieldDiscretization *)_type))
2228 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform mergeNodes !");
2229 MEDCouplingAutoRefCountObjectPtr<MEDCouplingPointSet> meshC2((MEDCouplingPointSet *)meshC->deepCpy());
2232 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> arr=meshC2->mergeNodes(eps,ret,ret2);
2233 if(!ret)//no nodes have been merged.
2235 std::vector<DataArrayDouble *> arrays;
2236 _time_discr->getArrays(arrays);
2237 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
2239 _type->renumberValuesOnNodes(epsOnVals,arr->getConstPointer(),meshC2->getNumberOfNodes(),*iter);
2245 * Merges coincident nodes of the underlying mesh. If some nodes are coincident, the
2246 * underlying mesh is replaced by a new mesh instance where the coincident nodes are
2248 * In contrast to mergeNodes(), location of merged nodes is changed to be at their barycenter.
2249 * \param [in] eps - a precision used to compare nodes of the two meshes.
2250 * \param [in] epsOnVals - a precision used to compare field
2251 * values at merged nodes. If the values differ more than \a epsOnVals, an
2252 * exception is thrown.
2253 * \return bool - \c true if some nodes have been merged and hence \a this field lies
2255 * \throw If the mesh is of type not inheriting from MEDCouplingPointSet.
2256 * \throw If the mesh is not well defined.
2257 * \throw If the spatial discretization of \a this field is NULL.
2258 * \throw If the data array is not set.
2259 * \throw If field values at merged nodes (if any) deffer more than \a epsOnVals.
2261 bool MEDCouplingFieldDouble::mergeNodes2(double eps, double epsOnVals)
2263 const MEDCouplingPointSet *meshC=dynamic_cast<const MEDCouplingPointSet *>(_mesh);
2265 throw INTERP_KERNEL::Exception("Invalid support mesh to apply mergeNodes on it : must be a MEDCouplingPointSet one !");
2266 if(!((const MEDCouplingFieldDiscretization *)_type))
2267 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform mergeNodes2 !");
2268 MEDCouplingAutoRefCountObjectPtr<MEDCouplingPointSet> meshC2((MEDCouplingPointSet *)meshC->deepCpy());
2271 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> arr=meshC2->mergeNodes2(eps,ret,ret2);
2272 if(!ret)//no nodes have been merged.
2274 std::vector<DataArrayDouble *> arrays;
2275 _time_discr->getArrays(arrays);
2276 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
2278 _type->renumberValuesOnNodes(epsOnVals,arr->getConstPointer(),meshC2->getNumberOfNodes(),*iter);
2284 * Removes from the underlying mesh nodes not used in any cell. If some nodes are
2285 * removed, the underlying mesh is replaced by a new mesh instance where the unused
2286 * nodes are removed.<br>
2287 * \param [in] epsOnVals - a precision used to compare field
2288 * values at merged nodes. If the values differ more than \a epsOnVals, an
2289 * exception is thrown.
2290 * \return bool - \c true if some nodes have been removed and hence \a this field lies
2292 * \throw If the mesh is of type not inheriting from MEDCouplingPointSet.
2293 * \throw If the mesh is not well defined.
2294 * \throw If the spatial discretization of \a this field is NULL.
2295 * \throw If the data array is not set.
2296 * \throw If field values at merged nodes (if any) deffer more than \a epsOnVals.
2298 bool MEDCouplingFieldDouble::zipCoords(double epsOnVals)
2300 const MEDCouplingPointSet *meshC=dynamic_cast<const MEDCouplingPointSet *>(_mesh);
2302 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::zipCoords : Invalid support mesh to apply zipCoords on it : must be a MEDCouplingPointSet one !");
2303 if(!((const MEDCouplingFieldDiscretization *)_type))
2304 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform zipCoords !");
2305 MEDCouplingAutoRefCountObjectPtr<MEDCouplingPointSet> meshC2((MEDCouplingPointSet *)meshC->deepCpy());
2306 int oldNbOfNodes=meshC2->getNumberOfNodes();
2307 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> arr=meshC2->zipCoordsTraducer();
2308 if(meshC2->getNumberOfNodes()!=oldNbOfNodes)
2310 std::vector<DataArrayDouble *> arrays;
2311 _time_discr->getArrays(arrays);
2312 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
2314 _type->renumberValuesOnNodes(epsOnVals,arr->getConstPointer(),meshC2->getNumberOfNodes(),*iter);
2322 * Removes duplicates of cells from the understanding mesh. If some cells are
2323 * removed, the underlying mesh is replaced by a new mesh instance where the cells
2324 * duplicates are removed.<br>
2325 * \param [in] compType - specifies a cell comparison technique. Meaning of its
2326 * valid values [0,1,2] is explained in the description of
2327 * MEDCouplingPointSet::zipConnectivityTraducer() which is called by this method.
2328 * \param [in] epsOnVals - a precision used to compare field
2329 * values at merged cells. If the values differ more than \a epsOnVals, an
2330 * exception is thrown.
2331 * \return bool - \c true if some cells have been removed and hence \a this field lies
2333 * \throw If the mesh is not an instance of MEDCouplingUMesh.
2334 * \throw If the mesh is not well defined.
2335 * \throw If the spatial discretization of \a this field is NULL.
2336 * \throw If the data array is not set.
2337 * \throw If field values at merged cells (if any) deffer more than \a epsOnVals.
2339 bool MEDCouplingFieldDouble::zipConnectivity(int compType, double epsOnVals)
2341 const MEDCouplingUMesh *meshC=dynamic_cast<const MEDCouplingUMesh *>(_mesh);
2343 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::zipConnectivity : Invalid support mesh to apply zipCoords on it : must be a MEDCouplingPointSet one !");
2344 if(!((const MEDCouplingFieldDiscretization *)_type))
2345 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform zipConnectivity !");
2346 MEDCouplingAutoRefCountObjectPtr<MEDCouplingUMesh> meshC2((MEDCouplingUMesh *)meshC->deepCpy());
2347 int oldNbOfCells=meshC2->getNumberOfCells();
2348 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> arr=meshC2->zipConnectivityTraducer(compType);
2349 if(meshC2->getNumberOfCells()!=oldNbOfCells)
2351 std::vector<DataArrayDouble *> arrays;
2352 _time_discr->getArrays(arrays);
2353 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
2355 _type->renumberValuesOnCells(epsOnVals,meshC,arr->getConstPointer(),meshC2->getNumberOfCells(),*iter);
2363 * This method calls MEDCouplingUMesh::buildSlice3D method. So this method makes the assumption that underlying mesh exists.
2364 * For the moment, this method is implemented for fields on cells.
2366 * \return a newly allocated field double containing the result that the user should deallocate.
2368 MEDCouplingFieldDouble *MEDCouplingFieldDouble::extractSlice3D(const double *origin, const double *vec, double eps) const
2370 const MEDCouplingMesh *mesh=getMesh();
2372 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::extractSlice3D : underlying mesh is null !");
2373 if(getTypeOfField()!=ON_CELLS)
2374 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::extractSlice3D : only implemented for fields on cells !");
2375 const MEDCouplingAutoRefCountObjectPtr<MEDCouplingUMesh> umesh(mesh->buildUnstructured());
2376 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=clone(false);
2377 ret->setMesh(umesh);
2378 DataArrayInt *cellIds=0;
2379 MEDCouplingAutoRefCountObjectPtr<MEDCouplingUMesh> mesh2=umesh->buildSlice3D(origin,vec,eps,cellIds);
2380 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> cellIds2=cellIds;
2381 ret->setMesh(mesh2);
2382 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> tupleIds=computeTupleIdsToSelectFromCellIds(cellIds->begin(),cellIds->end());
2383 std::vector<DataArrayDouble *> arrays;
2384 _time_discr->getArrays(arrays);
2386 std::vector<DataArrayDouble *> newArr(arrays.size());
2387 std::vector< MEDCouplingAutoRefCountObjectPtr<DataArrayDouble> > newArr2(arrays.size());
2388 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++,i++)
2392 newArr2[i]=(*iter)->selectByTupleIdSafe(cellIds->begin(),cellIds->end());
2393 newArr[i]=newArr2[i];
2396 ret->setArrays(newArr);
2401 * Divides every cell of the underlying mesh into simplices (triangles in 2D and
2402 * tetrahedra in 3D). If some cells are divided, the underlying mesh is replaced by a new
2403 * mesh instance containing the simplices.<br>
2404 * \param [in] policy - specifies a pattern used for splitting. For its description, see
2405 * MEDCouplingUMesh::simplexize().
2406 * \return bool - \c true if some cells have been divided and hence \a this field lies
2408 * \throw If \a policy has an invalid value. For valid values, see the description of
2409 * MEDCouplingUMesh::simplexize().
2410 * \throw If MEDCouplingMesh::simplexize() is not applicable to the underlying mesh.
2411 * \throw If the mesh is not well defined.
2412 * \throw If the spatial discretization of \a this field is NULL.
2413 * \throw If the data array is not set.
2415 bool MEDCouplingFieldDouble::simplexize(int policy)
2418 throw INTERP_KERNEL::Exception("No underlying mesh on this field to perform simplexize !");
2419 if(!((const MEDCouplingFieldDiscretization *)_type))
2420 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform simplexize !");
2421 int oldNbOfCells=_mesh->getNumberOfCells();
2422 MEDCouplingAutoRefCountObjectPtr<MEDCouplingMesh> meshC2(_mesh->deepCpy());
2423 MEDCouplingAutoRefCountObjectPtr<DataArrayInt> arr=meshC2->simplexize(policy);
2424 int newNbOfCells=meshC2->getNumberOfCells();
2425 if(oldNbOfCells==newNbOfCells)
2427 std::vector<DataArrayDouble *> arrays;
2428 _time_discr->getArrays(arrays);
2429 for(std::vector<DataArrayDouble *>::const_iterator iter=arrays.begin();iter!=arrays.end();iter++)
2431 _type->renumberValuesOnCellsR(_mesh,arr->getConstPointer(),arr->getNbOfElems(),*iter);
2437 * Creates a new MEDCouplingFieldDouble filled with the doubly contracted product of
2438 * every tensor of \a this 6-componental field.
2439 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble, whose
2440 * each tuple is calculated from the tuple <em>(t)</em> of \a this field as
2441 * follows: \f$ t[0]^2+t[1]^2+t[2]^2+2*t[3]^2+2*t[4]^2+2*t[5]^2\f$.
2442 * This new field lies on the same mesh as \a this one. The caller is to delete
2443 * this field using decrRef() as it is no more needed.
2444 * \throw If \a this->getNumberOfComponents() != 6.
2445 * \throw If the spatial discretization of \a this field is NULL.
2447 MEDCouplingFieldDouble *MEDCouplingFieldDouble::doublyContractedProduct() const
2449 if(!((const MEDCouplingFieldDiscretization *)_type))
2450 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform doublyContractedProduct !");
2451 MEDCouplingTimeDiscretization *td=_time_discr->doublyContractedProduct();
2452 td->copyTinyAttrFrom(*_time_discr);
2453 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2454 ret->setName("DoublyContractedProduct");
2455 ret->setMesh(getMesh());
2460 * Creates a new MEDCouplingFieldDouble filled with the determinant of a square
2461 * matrix defined by every tuple of \a this field, having either 4, 6 or 9 components.
2462 * The case of 6 components corresponds to that of the upper triangular matrix.
2463 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble, whose
2464 * each tuple is the determinant of matrix of the corresponding tuple of \a this
2465 * field. This new field lies on the same mesh as \a this one. The caller is to
2466 * delete this field using decrRef() as it is no more needed.
2467 * \throw If \a this->getNumberOfComponents() is not in [4,6,9].
2468 * \throw If the spatial discretization of \a this field is NULL.
2470 MEDCouplingFieldDouble *MEDCouplingFieldDouble::determinant() const
2472 if(!((const MEDCouplingFieldDiscretization *)_type))
2473 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform determinant !");
2474 MEDCouplingTimeDiscretization *td=_time_discr->determinant();
2475 td->copyTinyAttrFrom(*_time_discr);
2476 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2477 ret->setName("Determinant");
2478 ret->setMesh(getMesh());
2484 * Creates a new MEDCouplingFieldDouble with 3 components filled with 3 eigenvalues of
2485 * an upper triangular matrix defined by every tuple of \a this 6-componental field.
2486 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble,
2487 * having 3 components, whose each tuple contains the eigenvalues of the matrix of
2488 * corresponding tuple of \a this field. This new field lies on the same mesh as
2489 * \a this one. The caller is to delete this field using decrRef() as it is no
2491 * \throw If \a this->getNumberOfComponents() != 6.
2492 * \throw If the spatial discretization of \a this field is NULL.
2494 MEDCouplingFieldDouble *MEDCouplingFieldDouble::eigenValues() const
2496 if(!((const MEDCouplingFieldDiscretization *)_type))
2497 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform eigenValues !");
2498 MEDCouplingTimeDiscretization *td=_time_discr->eigenValues();
2499 td->copyTinyAttrFrom(*_time_discr);
2500 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2501 ret->setName("EigenValues");
2502 ret->setMesh(getMesh());
2507 * Creates a new MEDCouplingFieldDouble with 9 components filled with 3 eigenvectors of
2508 * an upper triangular matrix defined by every tuple of \a this 6-componental field.
2509 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble,
2510 * having 9 components, whose each tuple contains the eigenvectors of the matrix of
2511 * corresponding tuple of \a this field. This new field lies on the same mesh as
2512 * \a this one. The caller is to delete this field using decrRef() as it is no
2514 * \throw If \a this->getNumberOfComponents() != 6.
2515 * \throw If the spatial discretization of \a this field is NULL.
2517 MEDCouplingFieldDouble *MEDCouplingFieldDouble::eigenVectors() const
2519 if(!((const MEDCouplingFieldDiscretization *)_type))
2520 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform eigenVectors !");
2521 MEDCouplingTimeDiscretization *td=_time_discr->eigenVectors();
2522 td->copyTinyAttrFrom(*_time_discr);
2523 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2524 ret->setName("EigenVectors");
2525 ret->setMesh(getMesh());
2530 * Creates a new MEDCouplingFieldDouble filled with the inverse matrix of
2531 * a matrix defined by every tuple of \a this field having either 4, 6 or 9
2532 * components. The case of 6 components corresponds to that of the upper triangular
2534 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble,
2535 * having the same number of components as \a this one, whose each tuple
2536 * contains the inverse matrix of the matrix of corresponding tuple of \a this
2537 * field. This new field lies on the same mesh as \a this one. The caller is to
2538 * delete this field using decrRef() as it is no more needed.
2539 * \throw If \a this->getNumberOfComponents() is not in [4,6,9].
2540 * \throw If the spatial discretization of \a this field is NULL.
2542 MEDCouplingFieldDouble *MEDCouplingFieldDouble::inverse() const
2544 if(!((const MEDCouplingFieldDiscretization *)_type))
2545 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform inverse !");
2546 MEDCouplingTimeDiscretization *td=_time_discr->inverse();
2547 td->copyTinyAttrFrom(*_time_discr);
2548 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2549 ret->setName("Inversion");
2550 ret->setMesh(getMesh());
2555 * Creates a new MEDCouplingFieldDouble filled with the trace of
2556 * a matrix defined by every tuple of \a this field having either 4, 6 or 9
2557 * components. The case of 6 components corresponds to that of the upper triangular
2559 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble,
2560 * having 1 component, whose each tuple is the trace of the matrix of
2561 * corresponding tuple of \a this field.
2562 * This new field lies on the same mesh as \a this one. The caller is to
2563 * delete this field using decrRef() as it is no more needed.
2564 * \throw If \a this->getNumberOfComponents() is not in [4,6,9].
2565 * \throw If the spatial discretization of \a this field is NULL.
2567 MEDCouplingFieldDouble *MEDCouplingFieldDouble::trace() const
2569 if(!((const MEDCouplingFieldDiscretization *)_type))
2570 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform trace !");
2571 MEDCouplingTimeDiscretization *td=_time_discr->trace();
2572 td->copyTinyAttrFrom(*_time_discr);
2573 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2574 ret->setName("Trace");
2575 ret->setMesh(getMesh());
2580 * Creates a new MEDCouplingFieldDouble filled with the stress deviator tensor of
2581 * a stress tensor defined by every tuple of \a this 6-componental field.
2582 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble,
2583 * having same number of components and tuples as \a this field,
2584 * whose each tuple contains the stress deviator tensor of the stress tensor of
2585 * corresponding tuple of \a this field. This new field lies on the same mesh as
2586 * \a this one. The caller is to delete this field using decrRef() as it is no
2588 * \throw If \a this->getNumberOfComponents() != 6.
2589 * \throw If the spatial discretization of \a this field is NULL.
2591 MEDCouplingFieldDouble *MEDCouplingFieldDouble::deviator() const
2593 if(!((const MEDCouplingFieldDiscretization *)_type))
2594 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform deviator !");
2595 MEDCouplingTimeDiscretization *td=_time_discr->deviator();
2596 td->copyTinyAttrFrom(*_time_discr);
2597 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2598 ret->setName("Deviator");
2599 ret->setMesh(getMesh());
2604 * Creates a new MEDCouplingFieldDouble filled with the magnitude of
2605 * every vector of \a this field.
2606 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble,
2607 * having one component, whose each tuple is the magnitude of the vector
2608 * of corresponding tuple of \a this field. This new field lies on the
2609 * same mesh as \a this one. The caller is to
2610 * delete this field using decrRef() as it is no more needed.
2611 * \throw If the spatial discretization of \a this field is NULL.
2613 MEDCouplingFieldDouble *MEDCouplingFieldDouble::magnitude() const
2615 if(!((const MEDCouplingFieldDiscretization *)_type))
2616 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform magnitude !");
2617 MEDCouplingTimeDiscretization *td=_time_discr->magnitude();
2618 td->copyTinyAttrFrom(*_time_discr);
2619 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2620 ret->setName("Magnitude");
2621 ret->setMesh(getMesh());
2626 * Creates a new scalar MEDCouplingFieldDouble filled with the maximal value among
2627 * values of every tuple of \a this field.
2628 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
2629 * This new field lies on the same mesh as \a this one. The caller is to
2630 * delete this field using decrRef() as it is no more needed.
2631 * \throw If the spatial discretization of \a this field is NULL.
2633 MEDCouplingFieldDouble *MEDCouplingFieldDouble::maxPerTuple() const
2635 if(!((const MEDCouplingFieldDiscretization *)_type))
2636 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform maxPerTuple !");
2637 MEDCouplingTimeDiscretization *td=_time_discr->maxPerTuple();
2638 td->copyTinyAttrFrom(*_time_discr);
2639 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2640 std::ostringstream oss;
2641 oss << "Max_" << getName();
2642 ret->setName(oss.str());
2643 ret->setMesh(getMesh());
2648 * Changes number of components in \a this field. If \a newNbOfComp is less
2649 * than \a this->getNumberOfComponents() then each tuple
2650 * is truncated to have \a newNbOfComp components, keeping first components. If \a
2651 * newNbOfComp is more than \a this->getNumberOfComponents() then
2652 * each tuple is populated with \a dftValue to have \a newNbOfComp components.
2653 * \param [in] newNbOfComp - number of components for the new field to have.
2654 * \param [in] dftValue - value assigned to new values added to \a this field.
2655 * \throw If \a this is not allocated.
2657 void MEDCouplingFieldDouble::changeNbOfComponents(int newNbOfComp, double dftValue)
2659 _time_discr->changeNbOfComponents(newNbOfComp,dftValue);
2663 * Creates a new MEDCouplingFieldDouble composed of selected components of \a this field.
2664 * The new MEDCouplingFieldDouble has the same number of tuples but includes components
2665 * specified by \a compoIds parameter. So that getNbOfElems() of the result field
2666 * can be either less, same or more than \a this->getNumberOfValues().
2667 * \param [in] compoIds - sequence of zero based indices of components to include
2668 * into the new field.
2669 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble that the caller
2670 * is to delete using decrRef() as it is no more needed.
2671 * \throw If a component index (\a i) is not valid:
2672 * \a i < 0 || \a i >= \a this->getNumberOfComponents().
2674 MEDCouplingFieldDouble *MEDCouplingFieldDouble::keepSelectedComponents(const std::vector<int>& compoIds) const
2676 if(!((const MEDCouplingFieldDiscretization *)_type))
2677 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform keepSelectedComponents !");
2678 MEDCouplingTimeDiscretization *td=_time_discr->keepSelectedComponents(compoIds);
2679 td->copyTinyAttrFrom(*_time_discr);
2680 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2681 ret->setName(getName());
2682 ret->setMesh(getMesh());
2688 * Copy all components in a specified order from another field.
2689 * The number of tuples in \a this and the other field can be different.
2690 * \param [in] f - the field to copy data from.
2691 * \param [in] compoIds - sequence of zero based indices of components, data of which is
2693 * \throw If the two fields have different number of data arrays.
2694 * \throw If a data array is set in one of fields and is not set in the other.
2695 * \throw If \a compoIds.size() != \a a->getNumberOfComponents().
2696 * \throw If \a compoIds[i] < 0 or \a compoIds[i] > \a this->getNumberOfComponents().
2698 void MEDCouplingFieldDouble::setSelectedComponents(const MEDCouplingFieldDouble *f, const std::vector<int>& compoIds)
2700 _time_discr->setSelectedComponents(f->_time_discr,compoIds);
2704 * Sorts value within every tuple of \a this field.
2705 * \param [in] asc - if \a true, the values are sorted in ascending order, else,
2706 * in descending order.
2707 * \throw If a data array is not allocated.
2709 void MEDCouplingFieldDouble::sortPerTuple(bool asc)
2711 _time_discr->sortPerTuple(asc);
2715 * Creates a new MEDCouplingFieldDouble by concatenating two given fields.
2717 * the first field precede values of the second field within the result field.
2718 * \param [in] f1 - the first field.
2719 * \param [in] f2 - the second field.
2720 * \return MEDCouplingFieldDouble * - the result field. It is a new instance of
2721 * MEDCouplingFieldDouble. The caller is to delete this mesh using decrRef()
2722 * as it is no more needed.
2723 * \throw If the fields are not compatible for the merge.
2724 * \throw If the spatial discretization of \a f1 is NULL.
2725 * \throw If the time discretization of \a f1 is NULL.
2727 * \if ENABLE_EXAMPLES
2728 * \ref cpp_mcfielddouble_MergeFields "Here is a C++ example".<br>
2729 * \ref py_mcfielddouble_MergeFields "Here is a Python example".
2732 MEDCouplingFieldDouble *MEDCouplingFieldDouble::MergeFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
2734 if(!f1->areCompatibleForMerge(f2))
2735 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply MergeFields on them !");
2736 const MEDCouplingMesh *m1(f1->getMesh()),*m2(f2->getMesh());
2737 if(!f1->_time_discr)
2738 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::MergeFields : no time discr of f1 !");
2740 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::MergeFields : no spatial discr of f1 !");
2741 MEDCouplingTimeDiscretization *td=f1->_time_discr->aggregate(f2->_time_discr);
2742 td->copyTinyAttrFrom(*f1->_time_discr);
2743 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
2744 ret->setName(f1->getName());
2745 ret->setDescription(f1->getDescription());
2748 MEDCouplingAutoRefCountObjectPtr<MEDCouplingMesh> m=m1->mergeMyselfWith(m2);
2755 * Creates a new MEDCouplingFieldDouble by concatenating all given fields.
2756 * Values of the *i*-th field precede values of the (*i*+1)-th field within the result.
2757 * If there is only one field in \a a, a deepCopy() (except time information of mesh and
2758 * field) of the field is returned.
2759 * Generally speaking the first field in \a a is used to assign tiny attributes of the
2761 * \param [in] a - a vector of fields (MEDCouplingFieldDouble) to concatenate.
2762 * \return MEDCouplingFieldDouble * - the result field. It is a new instance of
2763 * MEDCouplingFieldDouble. The caller is to delete this mesh using decrRef()
2764 * as it is no more needed.
2765 * \throw If \a a is empty.
2766 * \throw If the fields are not compatible for the merge.
2768 * \if ENABLE_EXAMPLES
2769 * \ref cpp_mcfielddouble_MergeFields "Here is a C++ example".<br>
2770 * \ref py_mcfielddouble_MergeFields "Here is a Python example".
2773 MEDCouplingFieldDouble *MEDCouplingFieldDouble::MergeFields(const std::vector<const MEDCouplingFieldDouble *>& a)
2776 throw INTERP_KERNEL::Exception("FieldDouble::MergeFields : size of array must be >= 1 !");
2777 std::vector< MEDCouplingAutoRefCountObjectPtr<MEDCouplingUMesh> > ms(a.size());
2778 std::vector< const MEDCouplingUMesh *> ms2(a.size());
2779 std::vector< const MEDCouplingTimeDiscretization *> tds(a.size());
2780 std::vector<const MEDCouplingFieldDouble *>::const_iterator it=a.begin();
2781 const MEDCouplingFieldDouble *ref=(*it++);
2783 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::MergeFields : presence of NULL instance in first place of input vector !");
2784 for(;it!=a.end();it++)
2785 if(!ref->areCompatibleForMerge(*it))
2786 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply MergeFields on them !");
2787 for(int i=0;i<(int)a.size();i++)
2790 { ms[i]=a[i]->getMesh()->buildUnstructured(); ms2[i]=ms[i]; }
2792 { ms[i]=0; ms2[i]=0; }
2793 tds[i]=a[i]->_time_discr;
2795 MEDCouplingTimeDiscretization *td=tds[0]->aggregate(tds);
2796 td->copyTinyAttrFrom(*(a[0]->_time_discr));
2797 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(a[0]->getNature(),td,a[0]->_type->clone());
2798 ret->setName(a[0]->getName());
2799 ret->setDescription(a[0]->getDescription());
2802 MEDCouplingAutoRefCountObjectPtr<MEDCouplingUMesh> m=MEDCouplingUMesh::MergeUMeshes(ms2);
2803 m->copyTinyInfoFrom(ms2[0]);
2810 * Creates a new MEDCouplingFieldDouble by concatenating components of two given fields.
2811 * The number of components in the result field is a sum of the number of components of
2812 * given fields. The number of tuples in the result field is same as that of each of given
2814 * Number of tuples in the given fields must be the same.
2815 * \param [in] f1 - a field to include in the result field.
2816 * \param [in] f2 - another field to include in the result field.
2817 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
2818 * The caller is to delete this result field using decrRef() as it is no more
2820 * \throw If the fields are not compatible for a meld (areCompatibleForMeld()).
2821 * \throw If any of data arrays is not allocated.
2822 * \throw If \a f1->getNumberOfTuples() != \a f2->getNumberOfTuples()
2824 MEDCouplingFieldDouble *MEDCouplingFieldDouble::MeldFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
2826 if(!f1->areCompatibleForMeld(f2))
2827 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply MeldFields on them !");
2828 MEDCouplingTimeDiscretization *td=f1->_time_discr->meld(f2->_time_discr);
2829 td->copyTinyAttrFrom(*f1->_time_discr);
2830 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
2831 ret->setMesh(f1->getMesh());
2836 * Returns a new MEDCouplingFieldDouble containing a dot product of two given fields,
2837 * so that the i-th tuple of the result field is a sum of products of j-th components of
2838 * i-th tuples of given fields (\f$ f_i = \sum_{j=1}^n f1_j * f2_j \f$).
2839 * Number of tuples and components in the given fields must be the same.
2840 * \param [in] f1 - a given field.
2841 * \param [in] f2 - another given field.
2842 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
2843 * The caller is to delete this result field using decrRef() as it is no more
2845 * \throw If either \a f1 or \a f2 is NULL.
2846 * \throw If the fields are not strictly compatible (areStrictlyCompatible()), i.e. they
2847 * differ not only in values.
2849 MEDCouplingFieldDouble *MEDCouplingFieldDouble::DotFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
2852 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::DotFields : input field is NULL !");
2853 if(!f1->areStrictlyCompatible(f2))
2854 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply DotFields on them !");
2855 MEDCouplingTimeDiscretization *td=f1->_time_discr->dot(f2->_time_discr);
2856 td->copyTinyAttrFrom(*f1->_time_discr);
2857 MEDCouplingFieldDouble *ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
2858 ret->setMesh(f1->getMesh());
2863 * Returns a new MEDCouplingFieldDouble containing a cross product of two given fields,
2865 * the i-th tuple of the result field is a 3D vector which is a cross
2866 * product of two vectors defined by the i-th tuples of given fields.
2867 * Number of tuples in the given fields must be the same.
2868 * Number of components in the given fields must be 3.
2869 * \param [in] f1 - a given field.
2870 * \param [in] f2 - another given field.
2871 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
2872 * The caller is to delete this result field using decrRef() as it is no more
2874 * \throw If either \a f1 or \a f2 is NULL.
2875 * \throw If \a f1->getNumberOfComponents() != 3
2876 * \throw If \a f2->getNumberOfComponents() != 3
2877 * \throw If the fields are not strictly compatible (areStrictlyCompatible()), i.e. they
2878 * differ not only in values.
2880 MEDCouplingFieldDouble *MEDCouplingFieldDouble::CrossProductFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
2883 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::CrossProductFields : input field is NULL !");
2884 if(!f1->areStrictlyCompatible(f2))
2885 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply CrossProductFields on them !");
2886 MEDCouplingTimeDiscretization *td=f1->_time_discr->crossProduct(f2->_time_discr);
2887 td->copyTinyAttrFrom(*f1->_time_discr);
2888 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
2889 ret->setMesh(f1->getMesh());
2894 * Returns a new MEDCouplingFieldDouble containing maximal values of two given fields.
2895 * Number of tuples and components in the given fields must be the same.
2896 * \param [in] f1 - a field to compare values with another one.
2897 * \param [in] f2 - another field to compare values with the first one.
2898 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
2899 * The caller is to delete this result field using decrRef() as it is no more
2901 * \throw If either \a f1 or \a f2 is NULL.
2902 * \throw If the fields are not strictly compatible (areStrictlyCompatible()), i.e. they
2903 * differ not only in values.
2905 * \if ENABLE_EXAMPLES
2906 * \ref cpp_mcfielddouble_MaxFields "Here is a C++ example".<br>
2907 * \ref py_mcfielddouble_MaxFields "Here is a Python example".
2910 MEDCouplingFieldDouble *MEDCouplingFieldDouble::MaxFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
2913 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::MaxFields : input field is NULL !");
2914 if(!f1->areStrictlyCompatible(f2))
2915 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply MaxFields on them !");
2916 MEDCouplingTimeDiscretization *td=f1->_time_discr->max(f2->_time_discr);
2917 td->copyTinyAttrFrom(*f1->_time_discr);
2918 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
2919 ret->setMesh(f1->getMesh());
2924 * Returns a new MEDCouplingFieldDouble containing minimal values of two given fields.
2925 * Number of tuples and components in the given fields must be the same.
2926 * \param [in] f1 - a field to compare values with another one.
2927 * \param [in] f2 - another field to compare values with the first one.
2928 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
2929 * The caller is to delete this result field using decrRef() as it is no more
2931 * \throw If either \a f1 or \a f2 is NULL.
2932 * \throw If the fields are not strictly compatible (areStrictlyCompatible()), i.e. they
2933 * differ not only in values.
2935 * \if ENABLE_EXAMPLES
2936 * \ref cpp_mcfielddouble_MaxFields "Here is a C++ example".<br>
2937 * \ref py_mcfielddouble_MaxFields "Here is a Python example".
2940 MEDCouplingFieldDouble *MEDCouplingFieldDouble::MinFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
2943 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::MinFields : input field is NULL !");
2944 if(!f1->areStrictlyCompatible(f2))
2945 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply MinFields on them !");
2946 MEDCouplingTimeDiscretization *td=f1->_time_discr->min(f2->_time_discr);
2947 td->copyTinyAttrFrom(*f1->_time_discr);
2948 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
2949 ret->setMesh(f1->getMesh());
2954 * Returns a copy of \a this field in which sign of all values is reversed.
2955 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble
2956 * containing the same number of tuples and components as \a this field.
2957 * The caller is to delete this result field using decrRef() as it is no more
2959 * \throw If the spatial discretization of \a this field is NULL.
2960 * \throw If a data array is not allocated.
2962 MEDCouplingFieldDouble *MEDCouplingFieldDouble::negate() const
2964 if(!((const MEDCouplingFieldDiscretization *)_type))
2965 throw INTERP_KERNEL::Exception("No spatial discretization underlying this field to perform negate !");
2966 MEDCouplingTimeDiscretization *td=_time_discr->negate();
2967 td->copyTinyAttrFrom(*_time_discr);
2968 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(getNature(),td,_type->clone());
2969 ret->setMesh(getMesh());
2974 * Returns a new MEDCouplingFieldDouble containing sum values of corresponding values of
2975 * two given fields ( _f_ [ i, j ] = _f1_ [ i, j ] + _f2_ [ i, j ] ).
2976 * Number of tuples and components in the given fields must be the same.
2977 * \param [in] f1 - a field to sum up.
2978 * \param [in] f2 - another field to sum up.
2979 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
2980 * The caller is to delete this result field using decrRef() as it is no more
2982 * \throw If either \a f1 or \a f2 is NULL.
2983 * \throw If the fields are not strictly compatible (areStrictlyCompatible()), i.e. they
2984 * differ not only in values.
2986 MEDCouplingFieldDouble *MEDCouplingFieldDouble::AddFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
2989 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::AddFields : input field is NULL !");
2990 if(!f1->areStrictlyCompatible(f2))
2991 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply AddFields on them !");
2992 MEDCouplingTimeDiscretization *td=f1->_time_discr->add(f2->_time_discr);
2993 td->copyTinyAttrFrom(*f1->_time_discr);
2994 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
2995 ret->setMesh(f1->getMesh());
3000 * Adds values of another MEDCouplingFieldDouble to values of \a this one
3001 * ( _this_ [ i, j ] += _other_ [ i, j ] ) using DataArrayDouble::addEqual().
3002 * The two fields must have same number of tuples, components and same underlying mesh.
3003 * \param [in] other - the field to add to \a this one.
3004 * \return const MEDCouplingFieldDouble & - a reference to \a this field.
3005 * \throw If \a other is NULL.
3006 * \throw If the fields are not strictly compatible (areStrictlyCompatible()), i.e. they
3007 * differ not only in values.
3009 const MEDCouplingFieldDouble &MEDCouplingFieldDouble::operator+=(const MEDCouplingFieldDouble& other)
3011 if(!areStrictlyCompatible(&other))
3012 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply += on them !");
3013 _time_discr->addEqual(other._time_discr);
3018 * Returns a new MEDCouplingFieldDouble containing subtraction of corresponding values of
3019 * two given fields ( _f_ [ i, j ] = _f1_ [ i, j ] - _f2_ [ i, j ] ).
3020 * Number of tuples and components in the given fields must be the same.
3021 * \param [in] f1 - a field to subtract from.
3022 * \param [in] f2 - a field to subtract.
3023 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
3024 * The caller is to delete this result field using decrRef() as it is no more
3026 * \throw If either \a f1 or \a f2 is NULL.
3027 * \throw If the fields are not strictly compatible (areStrictlyCompatible()), i.e. they
3028 * differ not only in values.
3030 MEDCouplingFieldDouble *MEDCouplingFieldDouble::SubstractFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
3033 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::SubstractFields : input field is NULL !");
3034 if(!f1->areStrictlyCompatible(f2))
3035 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply SubstractFields on them !");
3036 MEDCouplingTimeDiscretization *td=f1->_time_discr->substract(f2->_time_discr);
3037 td->copyTinyAttrFrom(*f1->_time_discr);
3038 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
3039 ret->setMesh(f1->getMesh());
3044 * Subtract values of another MEDCouplingFieldDouble from values of \a this one
3045 * ( _this_ [ i, j ] -= _other_ [ i, j ] ) using DataArrayDouble::substractEqual().
3046 * The two fields must have same number of tuples, components and same underlying mesh.
3047 * \param [in] other - the field to subtract from \a this one.
3048 * \return const MEDCouplingFieldDouble & - a reference to \a this field.
3049 * \throw If \a other is NULL.
3050 * \throw If the fields are not strictly compatible (areStrictlyCompatible()), i.e. they
3051 * differ not only in values.
3053 const MEDCouplingFieldDouble &MEDCouplingFieldDouble::operator-=(const MEDCouplingFieldDouble& other)
3055 if(!areStrictlyCompatible(&other))
3056 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply -= on them !");
3057 _time_discr->substractEqual(other._time_discr);
3062 * Returns a new MEDCouplingFieldDouble containing product values of
3063 * two given fields. There are 2 valid cases.
3064 * 1. The fields have same number of tuples and components. Then each value of
3065 * the result field (_f_) is a product of the corresponding values of _f1_ and
3066 * _f2_, i.e. _f_ [ i, j ] = _f1_ [ i, j ] * _f2_ [ i, j ].
3067 * 2. The fields have same number of tuples and one field, say _f2_, has one
3069 * _f_ [ i, j ] = _f1_ [ i, j ] * _f2_ [ i, 0 ].
3071 * The two fields must have same number of tuples and same underlying mesh.
3072 * \param [in] f1 - a factor field.
3073 * \param [in] f2 - another factor field.
3074 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
3075 * The caller is to delete this result field using decrRef() as it is no more
3077 * \throw If either \a f1 or \a f2 is NULL.
3078 * \throw If the fields are not compatible for production (areCompatibleForMul()),
3079 * i.e. they differ not only in values and possibly number of components.
3081 MEDCouplingFieldDouble *MEDCouplingFieldDouble::MultiplyFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
3084 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::MultiplyFields : input field is NULL !");
3085 if(!f1->areCompatibleForMul(f2))
3086 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply MultiplyFields on them !");
3087 MEDCouplingTimeDiscretization *td=f1->_time_discr->multiply(f2->_time_discr);
3088 td->copyTinyAttrFrom(*f1->_time_discr);
3089 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
3090 ret->setMesh(f1->getMesh());
3095 * Multiply values of another MEDCouplingFieldDouble to values of \a this one
3096 * using DataArrayDouble::multiplyEqual().
3097 * The two fields must have same number of tuples and same underlying mesh.
3098 * There are 2 valid cases.
3099 * 1. The fields have same number of components. Then each value of
3100 * \a other is multiplied to the corresponding value of \a this field, i.e.
3101 * _this_ [ i, j ] *= _other_ [ i, j ].
3102 * 2. The _other_ field has one component. Then
3103 * _this_ [ i, j ] *= _other_ [ i, 0 ].
3105 * The two fields must have same number of tuples and same underlying mesh.
3106 * \param [in] other - an field to multiply to \a this one.
3107 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
3108 * The caller is to delete this result field using decrRef() as it is no more
3110 * \throw If \a other is NULL.
3111 * \throw If the fields are not strictly compatible for production
3112 * (areCompatibleForMul()),
3113 * i.e. they differ not only in values and possibly in number of components.
3115 const MEDCouplingFieldDouble &MEDCouplingFieldDouble::operator*=(const MEDCouplingFieldDouble& other)
3117 if(!areCompatibleForMul(&other))
3118 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply *= on them !");
3119 _time_discr->multiplyEqual(other._time_discr);
3124 * Returns a new MEDCouplingFieldDouble containing division of two given fields.
3125 * There are 2 valid cases.
3126 * 1. The fields have same number of tuples and components. Then each value of
3127 * the result field (_f_) is a division of the corresponding values of \a f1 and
3128 * \a f2, i.e. _f_ [ i, j ] = _f1_ [ i, j ] / _f2_ [ i, j ].
3129 * 2. The fields have same number of tuples and _f2_ has one component. Then
3130 * _f_ [ i, j ] = _f1_ [ i, j ] / _f2_ [ i, 0 ].
3132 * \param [in] f1 - a numerator field.
3133 * \param [in] f2 - a denominator field.
3134 * \return MEDCouplingFieldDouble * - the new instance of MEDCouplingFieldDouble.
3135 * The caller is to delete this result field using decrRef() as it is no more
3137 * \throw If either \a f1 or \a f2 is NULL.
3138 * \throw If the fields are not compatible for division (areCompatibleForDiv()),
3139 * i.e. they differ not only in values and possibly in number of components.
3141 MEDCouplingFieldDouble *MEDCouplingFieldDouble::DivideFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
3144 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::DivideFields : input field is NULL !");
3145 if(!f1->areCompatibleForDiv(f2))
3146 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply DivideFields on them !");
3147 MEDCouplingTimeDiscretization *td=f1->_time_discr->divide(f2->_time_discr);
3148 td->copyTinyAttrFrom(*f1->_time_discr);
3149 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
3150 ret->setMesh(f1->getMesh());
3155 * Divide values of \a this field by values of another MEDCouplingFieldDouble
3156 * using DataArrayDouble::divideEqual().
3157 * The two fields must have same number of tuples and same underlying mesh.
3158 * There are 2 valid cases.
3159 * 1. The fields have same number of components. Then each value of
3160 * \a this field is divided by the corresponding value of \a other one, i.e.
3161 * _this_ [ i, j ] /= _other_ [ i, j ].
3162 * 2. The \a other field has one component. Then
3163 * _this_ [ i, j ] /= _other_ [ i, 0 ].
3165 * \warning No check of division by zero is performed!
3166 * \param [in] other - an field to divide \a this one by.
3167 * \throw If \a other is NULL.
3168 * \throw If the fields are not compatible for division (areCompatibleForDiv()),
3169 * i.e. they differ not only in values and possibly in number of components.
3171 const MEDCouplingFieldDouble &MEDCouplingFieldDouble::operator/=(const MEDCouplingFieldDouble& other)
3173 if(!areCompatibleForDiv(&other))
3174 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply /= on them !");
3175 _time_discr->divideEqual(other._time_discr);
3180 * Directly called by MEDCouplingFieldDouble::operator^.
3182 * \sa MEDCouplingFieldDouble::operator^
3184 MEDCouplingFieldDouble *MEDCouplingFieldDouble::PowFields(const MEDCouplingFieldDouble *f1, const MEDCouplingFieldDouble *f2)
3187 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::PowFields : input field is NULL !");
3188 if(!f1->areCompatibleForMul(f2))
3189 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply PowFields on them !");
3190 MEDCouplingTimeDiscretization *td=f1->_time_discr->pow(f2->_time_discr);
3191 td->copyTinyAttrFrom(*f1->_time_discr);
3192 MEDCouplingAutoRefCountObjectPtr<MEDCouplingFieldDouble> ret=new MEDCouplingFieldDouble(f1->getNature(),td,f1->_type->clone());
3193 ret->setMesh(f1->getMesh());
3198 * Directly call MEDCouplingFieldDouble::PowFields static method.
3200 * \sa MEDCouplingFieldDouble::PowFields
3202 MEDCouplingFieldDouble *MEDCouplingFieldDouble::operator^(const MEDCouplingFieldDouble& other) const
3204 return PowFields(this,&other);
3207 const MEDCouplingFieldDouble &MEDCouplingFieldDouble::operator^=(const MEDCouplingFieldDouble& other)
3209 if(!areCompatibleForDiv(&other))
3210 throw INTERP_KERNEL::Exception("Fields are not compatible ; unable to apply /= on them !");
3211 _time_discr->powEqual(other._time_discr);
3216 * Writes the field series \a fs and the mesh the fields lie on in the VTK file \a fileName.
3217 * If \a fs is empty no file is written.
3218 * The result file is valid provided that no exception is thrown.
3219 * \warning All the fields must be named and lie on the same non NULL mesh.
3220 * \param [in] fileName - the name of a VTK file to write in.
3221 * \param [in] fs - the fields to write.
3222 * \param [in] isBinary - specifies the VTK format of the written file. By default true (Binary mode)
3223 * \throw If \a fs[ 0 ] == NULL.
3224 * \throw If the fields lie not on the same mesh.
3225 * \throw If the mesh is not set.
3226 * \throw If any of the fields has no name.
3228 * \if ENABLE_EXAMPLES
3229 * \ref cpp_mcfielddouble_WriteVTK "Here is a C++ example".<br>
3230 * \ref py_mcfielddouble_WriteVTK "Here is a Python example".
3233 void MEDCouplingFieldDouble::WriteVTK(const std::string& fileName, const std::vector<const MEDCouplingFieldDouble *>& fs, bool isBinary)
3237 std::size_t nfs=fs.size();
3239 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::WriteVTK : 1st instance of field is NULL !");
3240 const MEDCouplingMesh *m=fs[0]->getMesh();
3242 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::WriteVTK : 1st instance of field lies on NULL mesh !");
3243 for(std::size_t i=1;i<nfs;i++)
3244 if(fs[i]->getMesh()!=m)
3245 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::WriteVTK : Fields are not lying on a same mesh ! Expected by VTK ! MEDCouplingFieldDouble::setMesh or MEDCouplingFieldDouble::changeUnderlyingMesh can help to that.");
3247 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::WriteVTK : Fields are lying on a same mesh but it is empty !");
3248 MEDCouplingAutoRefCountObjectPtr<DataArrayByte> byteArr;
3250 { byteArr=DataArrayByte::New(); byteArr->alloc(0,1); }
3251 std::ostringstream coss,noss;
3252 for(std::size_t i=0;i<nfs;i++)
3254 const MEDCouplingFieldDouble *cur=fs[i];
3255 std::string name(cur->getName());
3258 std::ostringstream oss; oss << "MEDCouplingFieldDouble::WriteVTK : Field in pos #" << i << " has no name !";
3259 throw INTERP_KERNEL::Exception(oss.str().c_str());
3261 TypeOfField typ=cur->getTypeOfField();
3263 cur->getArray()->writeVTK(coss,8,cur->getName(),byteArr);
3264 else if(typ==ON_NODES)
3265 cur->getArray()->writeVTK(noss,8,cur->getName(),byteArr);
3267 throw INTERP_KERNEL::Exception("MEDCouplingFieldDouble::WriteVTK : only node and cell fields supported for the moment !");
3269 m->writeVTKAdvanced(fileName,coss.str(),noss.str(),byteArr);
3272 void MEDCouplingFieldDouble::reprQuickOverview(std::ostream& stream) const
3274 stream << "MEDCouplingFieldDouble C++ instance at " << this << ". Name : \"" << _name << "\"." << std::endl;
3278 nat=MEDCouplingNatureOfField::GetRepr(_nature);
3279 stream << "Nature of field : " << nat << ".\n";
3281 catch(INTERP_KERNEL::Exception& /*e*/)
3283 const MEDCouplingFieldDiscretization *fd(_type);
3285 stream << "No spatial discretization set !";
3287 fd->reprQuickOverview(stream);
3288 stream << std::endl;
3290 stream << "\nNo mesh support defined !";
3293 std::ostringstream oss;
3294 _mesh->reprQuickOverview(oss);
3295 std::string tmp(oss.str());
3296 stream << "\nMesh info : " << tmp.substr(0,tmp.find('\n'));
3300 const DataArrayDouble *arr=_time_discr->getArray();
3303 stream << "\n\nArray info : ";
3304 arr->reprQuickOverview(stream);
3308 stream << "\n\nNo data array set !";