1 // Copyright (C) 2007-2020 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SMDS_ElementFactory.hxx
25 #ifndef _SMDS_ElementFactory_HeaderFile
26 #define _SMDS_ElementFactory_HeaderFile
28 #include "SMDS_MeshCell.hxx"
29 #include "SMDS_Position.hxx"
31 #include <Utils_SALOME_Exception.hxx>
33 #include <boost/container/flat_set.hpp>
34 #include <boost/dynamic_bitset.hpp>
35 #include <boost/make_shared.hpp>
36 #include <boost/ptr_container/ptr_vector.hpp>
37 #include <boost/shared_ptr.hpp>
43 class SMDS_ElementChunk;
48 struct _ChunkCompare {
49 bool operator () (const SMDS_ElementChunk* c1, const SMDS_ElementChunk* c2) const;
51 typedef boost::ptr_vector<SMDS_ElementChunk> TChunkVector;
52 typedef std::set<SMDS_ElementChunk*,_ChunkCompare> TChunkPtrSet;
54 //------------------------------------------------------------------------------------
56 * \brief Allocate SMDS_MeshElement's (SMDS_MeshCell's or SMDS_MeshNode's )
57 * and bind some attributes to elements:
58 * element ID, element VTK ID, sub-mesh ID, position on shape.
60 * Elements are allocated by chunks, so there are used and non-used elements
62 class SMDS_ElementFactory
65 bool myIsNodal; // what to allocate: nodes or cells
67 TChunkVector myChunks; // array of chunks of elements
68 TChunkPtrSet myChunksWithUnused; // sorted chunks having unused elements
69 std::vector< vtkIdType > myVtkIDs; // myVtkIDs[ smdsID-1 ] == vtkID
70 std::vector< int > mySmdsIDs; // mySmdsIDs[ vtkID ] == smdsID - 1
71 int myNbUsedElements; // counter of elements
73 friend class SMDS_ElementChunk;
77 SMDS_ElementFactory( SMDS_Mesh* mesh, const bool isNodal=false );
78 virtual ~SMDS_ElementFactory();
80 //! Return minimal ID of a non-used element
83 //! Return maximal ID of an used element
86 //! Return minimal ID of an used element
89 //! Return an element by ID. NULL if the element with the given ID is already used
90 SMDS_MeshElement* NewElement( const int id );
92 //! Return a SMDS_MeshCell by ID. NULL if the cell with the given ID is already used
93 SMDS_MeshCell* NewCell( const int id ) { return static_cast<SMDS_MeshCell*>( NewElement( id )); }
95 //! Return an used element by ID. NULL if the element with the given ID is not yet used
96 const SMDS_MeshElement* FindElement( const int id ) const;
98 //! Return a number of used elements
99 int NbUsedElements() const { return myNbUsedElements; }
101 //! Return an iterator on all element filtered using a given filter.
102 // nbElemsToReturn is used to optimize by stopping the iteration as soon as
103 // all elements satisfying filtering condition encountered.
104 template< class ElemIterator >
105 boost::shared_ptr< ElemIterator > GetIterator( SMDS_MeshElement::Filter* filter,
106 size_t nbElemsToReturn = -1 );
108 //! Return an iterator on all element assigned to a given shape.
109 // nbElemsToReturn is used to optimize by stopping the iteration as soon as
110 // all elements assigned to the shape encountered.
111 // sm1stElem is used to quickly find the first chunk holding elements of the shape;
112 // it must have smallest ID between elements on the shape
113 template< class ElemIterator >
114 boost::shared_ptr< ElemIterator > GetShapeIterator( int shapeID,
115 size_t nbElemsToReturn,
116 const SMDS_MeshElement* sm1stElem );
118 //! Mark the element as non-used
119 void Free( const SMDS_MeshElement* );
121 //! Return an SMDS ID by a Vtk one
122 int FromVtkToSmds( vtkIdType vtkID );
124 //! De-allocate all elements
125 virtual void Clear();
127 //! Remove unused elements located not at the end of the last chunk.
128 // Minimize allocated memory
129 virtual void Compact(std::vector<int>& idCellsOldToNew);
131 //! Return true if Compact() will change IDs of elements
132 virtual bool CompactChangePointers();
134 //! Return a number of elements in a chunk
135 static int ChunkSize();
138 //------------------------------------------------------------------------------------
140 * \brief Allocate SMDS_MeshNode's
142 class SMDS_NodeFactory : public SMDS_ElementFactory
144 std::vector<char> myShapeDim; // dimension of shapes
148 SMDS_NodeFactory( SMDS_Mesh* mesh );
151 //! Return a SMDS_MeshNode by ID. NULL if the node with the given ID is already used
152 SMDS_MeshNode* NewNode( int id ) { return (SMDS_MeshNode*) NewElement(id); }
154 //! Return an used node by ID. NULL if the node with the given ID is not yet used
155 const SMDS_MeshNode* FindNode( int id ) { return (const SMDS_MeshNode*) FindElement(id); }
157 //! Set a total number of sub-shapes in the main shape
158 void SetNbShapes( size_t nbShapes );
160 //! Return a dimension of a shape
161 int GetShapeDim( int shapeID ) const;
163 //! Set a dimension of a shape
164 void SetShapeDim( int shapeID, int dim );
166 //! De-allocate all nodes
167 virtual void Clear();
169 //! Remove unused nodes located not at the end of the last chunk.
170 // Minimize allocated memory
171 virtual void Compact(std::vector<int>& idNodesOldToNew);
173 //! Return true if Compact() will change IDs of node
174 virtual bool CompactChangePointers();
177 //------------------------------------------------------------------------------------
179 * \brief Range of elements in a chunk having the same attribute value
181 template< typename ATTR>
186 attr_t myValue; // common attribute value
187 int my1st; // index in the chunk of the 1st element
188 _Range( int i0 = 0, attr_t v = 0 ): myValue( v ), my1st( i0 ) {}
190 bool operator < (const _Range& other) const { return my1st < other.my1st; }
193 typedef std::vector< std::pair< int, int > > TIndexRanges;
195 //------------------------------------------------------------------------------------
197 * \brief Sorted set of ranges
199 template< class RANGE >
202 typedef typename RANGE::attr_t attr_t;
203 typedef boost::container::flat_set< RANGE > set_t;
204 typedef typename set_t::const_iterator set_iterator;
208 _RangeSet() { mySet.insert( RANGE( 0, 0 )); }
211 * \brief Return a number of ranges
213 size_t Size() const { return mySet.size(); }
216 * \brief Return a mutable _Range::my1st of a range pointed by an iterator
218 int& First( set_iterator rangePtr ) { return const_cast< int& >( rangePtr->my1st ); }
221 * \brief Return a number of elements in a range pointed by an iterator
223 size_t Size( set_iterator rangePtr ) const
226 ( rangePtr + 1 == mySet.end() ) ? SMDS_ElementFactory::ChunkSize() : ( rangePtr + 1 )->my1st;
227 return next1st - rangePtr->my1st;
231 * \brief Return ranges of indices (from,to) of elements having a given value
233 bool GetIndices( const attr_t theValue, TIndexRanges & theIndices,
234 const attr_t* theMinValue = 0, const attr_t* theMaxValue = 0) const
236 bool isFound = false;
238 // if ( sizeof( attr_t ) == sizeof( int ) && theMinValue )
239 // if ( theValue < *theMinValue || theValue > *theMaxValue )
242 for ( set_iterator it = mySet.begin(); it < mySet.end(); ++it )
244 if ( it->myValue == theValue )
246 theIndices.push_back( std::make_pair( it->my1st, it->my1st + Size( it )));
248 ++it; // the next range value differs from theValue
255 * \brief Return value of an element attribute
256 * \param [in] theIndex - element index
257 * \return attr_t - attribute value
259 attr_t GetValue( int theIndex ) const
261 set_iterator r = mySet.upper_bound( theIndex ) - 1;
266 * \brief Change value of an element attribute
267 * \param [in] theIndex - element index
268 * \param [in] theValue - attribute value
269 * \return attr_t - previous value
271 attr_t SetValue( int theIndex, attr_t theValue )
273 set_iterator rNext = mySet.end(); // case of adding elements
274 set_iterator r = rNext - 1;
275 if ( r->my1st > theIndex )
277 rNext = mySet.upper_bound( theIndex );
280 int rSize = Size( r ); // range size
281 attr_t rValue = r->myValue;
282 if ( rValue == theValue )
283 return rValue; // it happens while compacting
285 if ( r->my1st == theIndex ) // theIndex is the first in the range
287 bool joinPrev = // can join theIndex to the previous range
288 ( r->my1st > 0 && ( r-1 )->myValue == theValue );
292 bool joinNext = // can join to the next range
293 ( rNext != mySet.end() && rNext->myValue == theValue );
297 if ( joinNext ) // && joinPrev
299 mySet.erase( r, r + 2 );
301 else // joinPrev && !joinNext
308 if ( joinNext ) // && !joinPrev
310 r = mySet.erase( r ); // then r points to the next range
313 else // !joinPrev && !joinNext
315 const_cast< attr_t & >( r->myValue ) = theValue;
327 r = mySet.insert( r, RANGE( theIndex + 1, rValue )) - 1;
328 const_cast< attr_t & >( r->myValue ) = theValue;
332 else if ( r->my1st + rSize - 1 == theIndex ) // theIndex is last in the range
334 if ( rNext != mySet.end() && rNext->myValue == theValue ) // join to the next
340 mySet.insert( r, RANGE( theIndex, theValue ));
343 else // theIndex in the middle of the range
345 r = mySet.insert( r, RANGE( theIndex, theValue ));
346 r = mySet.insert( r, RANGE( theIndex + 1, rValue ));
350 }; // struct _RangeSet
353 typedef _Range< int > _ShapeIDRange; // sub-mesh ID range
354 typedef _Range< bool > _UsedRange; // range of used elements
356 typedef _RangeSet< _ShapeIDRange > TSubIDRangeSet;
357 typedef _RangeSet< _UsedRange > TUsedRangeSet;
358 typedef boost::dynamic_bitset<> TBitSet;
359 //typedef float TParam;
360 typedef double TParam;
361 //typedef std::unordered_set<int> TSubIDSet;
363 //------------------------------------------------------------------------------------
365 * \brief Allocate SMDS_MeshElement's (SMDS_MeshCell's or SMDS_MeshNode's )
366 * and bind some attributes to elements:
367 * element ID, sub-shape ID, isMarked flag, parameters on shape
369 class SMDS_ElementChunk
371 SMDS_ElementFactory* myFactory; // holder of this chunk
372 SMDS_MeshElement* myElements; // array of elements
373 int my1stID; // ID of myElements[0]
374 TBitSet myMarkedSet; // mark some elements
375 TUsedRangeSet myUsedRanges; // ranges of used/unused elements
376 TSubIDRangeSet mySubIDRanges; // ranges of elements on the same sub-shape
377 //TSubIDSet* mySubIDSet; // set of sub-shape IDs
378 // int myMinSubID; // min sub-shape ID
379 // int myMaxSubID; // max sub-shape ID
380 std::vector<TParam> myPositions; // UV parameters on shape: 2*param_t per an element
384 SMDS_ElementChunk( SMDS_ElementFactory* factory = 0, int id0 = 0 );
385 ~SMDS_ElementChunk();
387 //! Return an element by an index [0,ChunkSize()]
388 SMDS_MeshElement* Element(int index) { return & myElements[index]; }
390 //! Return an element by an index [0,ChunkSize()]
391 const SMDS_MeshElement* Element(int index) const { return & myElements[index]; }
393 //! Return ID of the first non-used element
394 int GetUnusedID() const;
396 //! Mark an element as used
397 void UseElement( const int index );
399 //! Mark an element as non-used
400 void Free( const SMDS_MeshElement* e );
402 //! Check if a given range holds used or non-used elements
403 static bool IsUsed( const _UsedRange& r ) { return r.myValue; }
405 //! Return index of an element in the chunk
406 int Index( const SMDS_MeshElement* e ) const { return e - myElements; }
408 //! Return ID of the 1st element in the chunk
409 int Get1stID() const { return my1stID; }
411 //! Return pointer to on-shape-parameters of a node
412 TParam* GetPositionPtr( const SMDS_MeshElement* node, bool allocate=false );
414 //! Return ranges of used/non-used elements
415 const TUsedRangeSet& GetUsedRanges() const { return myUsedRanges; }
416 const TUsedRangeSet& GetUsedRangesMinMax( bool& min, bool& max ) const
417 { min = false; max = true; return myUsedRanges; }
419 //! Return ranges of elements assigned to sub-shapes and min/max of sub-shape IDs
420 const TSubIDRangeSet& GetSubIDRangesMinMax( int& min, int& max ) const
421 { /*min = myMinSubID; max = myMaxSubID;*/ return mySubIDRanges; }
423 //! Minimize allocated memory
427 void Dump() const; // debug
430 // Methods called by SMDS_MeshElement
432 int GetID( const SMDS_MeshElement* e ) const;
434 int GetVtkID( const SMDS_MeshElement* e ) const;
435 void SetVTKID( const SMDS_MeshElement* e, const vtkIdType id );
437 int GetShapeID( const SMDS_MeshElement* e ) const;
438 void SetShapeID( const SMDS_MeshElement* e, int shapeID ) const;
440 bool IsMarked ( const SMDS_MeshElement* e ) const;
441 void SetIsMarked( const SMDS_MeshElement* e, bool is );
443 SMDS_PositionPtr GetPosition( const SMDS_MeshNode* n ) const;
444 void SetPosition( const SMDS_MeshNode* n, const SMDS_PositionPtr& pos, int shapeID );
446 SMDS_Mesh* GetMesh() { return myFactory->myMesh; }
449 //------------------------------------------------------------------------------------
451 * \brief Iterator on elements in chunks
453 template< class ELEM_ITERATOR, class RANGE_SET >
454 struct _ChunkIterator : public ELEM_ITERATOR
456 typedef typename ELEM_ITERATOR::value_type element_type;
457 typedef SMDS_MeshElement::Filter* filter_ptr;
458 typedef typename RANGE_SET::attr_t attr_type;
459 typedef const RANGE_SET& (SMDS_ElementChunk::*get_rangeset_fun)(attr_type&, attr_type&) const;
461 const SMDS_MeshElement* myElement;
462 TIndexRanges myRanges;
464 const TChunkVector& myChunks;
466 get_rangeset_fun myGetRangeSetFun;
468 attr_type myMinValue;
469 attr_type myMaxValue;
471 size_t myNbElemsToReturn;
474 _ChunkIterator( const TChunkVector & theChunks,
475 get_rangeset_fun theGetRangeSetFun,
476 attr_type theAttrValue,
477 SMDS_MeshElement::Filter* theFilter,
478 size_t theNbElemsToReturn = -1,
479 int theChunkIndex = 0):
482 myChunks( theChunks ),
483 myChunkIndex( theChunkIndex-1 ),
484 myGetRangeSetFun( theGetRangeSetFun ),
485 myValue( theAttrValue ),
486 myFilter( theFilter ),
487 myNbElemsToReturn( theNbElemsToReturn ),
502 virtual element_type next()
504 element_type result = (element_type) myElement;
505 myNbReturned += bool( result );
508 if ( myNbReturned < myNbElemsToReturn )
509 while ( ! nextInRange() )
511 if ( ++myRangeIndex >= (int)myRanges.size() )
515 while ( ++myChunkIndex < (int)myChunks.size() &&
516 !getRangeSet().GetIndices( myValue, myRanges, &myMinValue, &myMaxValue ))
518 if ( myChunkIndex >= (int)myChunks.size() )
527 if ( myRangeIndex < (int)myRanges.size() )
529 std::pair< int, int > & range = myRanges[ myRangeIndex ];
530 while ( range.first < range.second && !myElement )
532 myElement = myChunks[ myChunkIndex ].Element( range.first++ );
533 if ( !(*myFilter)( myElement ))
540 const RANGE_SET& getRangeSet()
542 return ( myChunks[ myChunkIndex ].*myGetRangeSetFun )( myMinValue, myMaxValue );
544 }; // struct _ChunkIterator
547 template< class ElemIterator >
548 boost::shared_ptr< ElemIterator >
549 SMDS_ElementFactory::GetIterator( SMDS_MeshElement::Filter* filter,
550 size_t nbElemsToReturn )
552 typedef _ChunkIterator< ElemIterator, TUsedRangeSet > TChuckIterator;
553 return boost::make_shared< TChuckIterator >( myChunks,
554 & SMDS_ElementChunk::GetUsedRangesMinMax,
560 template< class ElemIterator >
561 boost::shared_ptr< ElemIterator >
562 SMDS_ElementFactory::GetShapeIterator( int shapeID,
563 size_t nbElemsToReturn,
564 const SMDS_MeshElement* sm1stElem )
566 int iChunk = sm1stElem ? (( sm1stElem->GetID() - 1 ) / ChunkSize()) : 0;
567 typedef _ChunkIterator< ElemIterator, TSubIDRangeSet > TChuckIterator;
568 return boost::make_shared< TChuckIterator >( myChunks,
569 & SMDS_ElementChunk::GetSubIDRangesMinMax,
571 new SMDS_MeshElement::NonNullFilter(),