1 // Copyright (C) 2007-2016 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 template< class ElemIterator >
112 boost::shared_ptr< ElemIterator > GetShapeIterator( int shapeID, size_t nbElemsToReturn );
114 //! Mark the element as non-used
115 void Free( const SMDS_MeshElement* );
117 //! Return an SMDS ID by a Vtk one
118 int FromVtkToSmds( vtkIdType vtkID );
120 //! De-allocate all elements
121 virtual void Clear();
123 //! Remove unused elements located not at the end of the last chunk.
124 // Minimize allocated memory
125 virtual void Compact(std::vector<int>& idCellsOldToNew);
127 //! Return true if Compact() will change IDs of elements
128 virtual bool CompactChangePointers();
130 //! Return a number of elements in a chunk
131 static int ChunkSize();
134 //------------------------------------------------------------------------------------
136 * \brief Allocate SMDS_MeshNode's
138 class SMDS_NodeFactory : public SMDS_ElementFactory
140 std::vector<char> myShapeDim; // dimension of shapes
144 SMDS_NodeFactory( SMDS_Mesh* mesh );
147 //! Return a SMDS_MeshNode by ID. NULL if the node with the given ID is already used
148 SMDS_MeshNode* NewNode( int id ) { return (SMDS_MeshNode*) NewElement(id); }
150 //! Return an used node by ID. NULL if the node with the given ID is not yet used
151 const SMDS_MeshNode* FindNode( int id ) { return (const SMDS_MeshNode*) FindElement(id); }
153 //! Set a total number of sub-shapes in the main shape
154 void SetNbShapes( size_t nbShapes );
156 //! Return a dimension of a shape
157 int GetShapeDim( int shapeID ) const;
159 //! Set a dimension of a shape
160 void SetShapeDim( int shapeID, int dim );
162 //! De-allocate all nodes
163 virtual void Clear();
165 //! Remove unused nodes located not at the end of the last chunk.
166 // Minimize allocated memory
167 virtual void Compact(std::vector<int>& idNodesOldToNew);
169 //! Return true if Compact() will change IDs of node
170 virtual bool CompactChangePointers();
173 //------------------------------------------------------------------------------------
175 * \brief Range of elements in a chunk having the same attribute value
177 template< typename ATTR>
182 attr_t myValue; // common attribute value
183 int my1st; // index in the chunk of the 1st element
184 _Range( int i0 = 0, attr_t v = 0 ): myValue( v ), my1st( i0 ) {}
186 bool operator < (const _Range& other) const { return my1st < other.my1st; }
189 typedef std::vector< std::pair< int, int > > TIndexRanges;
191 //------------------------------------------------------------------------------------
193 * \brief Sorted set of ranges
195 template< class RANGE >
198 typedef typename RANGE::attr_t attr_t;
199 typedef boost::container::flat_set< RANGE > set_t;
200 typedef typename set_t::const_iterator set_iterator;
204 _RangeSet() { mySet.insert( RANGE( 0, 0 )); }
207 * \brief Return a number of ranges
209 size_t Size() const { return mySet.size(); }
212 * \brief Return a mutable _Range::my1st of a range pointed by an iterator
214 int& First( set_iterator rangePtr ) { return const_cast< int& >( rangePtr->my1st ); }
217 * \brief Return a number of elements in a range pointed by an iterator
219 size_t Size( set_iterator rangePtr ) const
222 ( rangePtr + 1 == mySet.end() ) ? SMDS_ElementFactory::ChunkSize() : ( rangePtr + 1 )->my1st;
223 return next1st - rangePtr->my1st;
227 * \brief Return ranges of indices (from,to) of elements having a given value
229 bool GetIndices( const attr_t theValue, TIndexRanges & theIndices,
230 const attr_t* theMinValue = 0, const attr_t* theMaxValue = 0) const
232 bool isFound = false;
234 if ( sizeof( attr_t ) == sizeof( int ) && theMinValue )
235 if ( theValue < *theMinValue || theValue > *theMaxValue )
238 for ( set_iterator it = mySet.begin(); it < mySet.end(); ++it )
240 if ( it->myValue == theValue )
242 theIndices.push_back( std::make_pair( it->my1st, it->my1st + Size( it )));
244 ++it; // the next range value differs from theValue
251 * \brief Return value of an element attribute
252 * \param [in] theIndex - element index
253 * \return attr_t - attribute value
255 attr_t GetValue( int theIndex ) const
257 set_iterator r = mySet.upper_bound( theIndex ) - 1;
262 * \brief Change value of an element attribute
263 * \param [in] theIndex - element index
264 * \param [in] theValue - attribute value
265 * \return attr_t - previous value
267 attr_t SetValue( int theIndex, attr_t theValue )
269 set_iterator rNext = mySet.end(); // case of adding elements
270 set_iterator r = rNext - 1;
271 if ( r->my1st > theIndex )
273 rNext = mySet.upper_bound( theIndex );
276 int rSize = Size( r ); // range size
277 attr_t rValue = r->myValue;
278 if ( rValue == theValue )
279 return rValue; // it happens while compacting
281 if ( r->my1st == theIndex ) // theIndex is the first in the range
283 bool joinPrev = // can join theIndex to the previous range
284 ( r->my1st > 0 && ( r-1 )->myValue == theValue );
288 bool joinNext = // can join to the next range
289 ( rNext != mySet.end() && rNext->myValue == theValue );
293 if ( joinNext ) // && joinPrev
295 mySet.erase( r, r + 2 );
297 else // joinPrev && !joinNext
304 if ( joinNext ) // && !joinPrev
306 r = mySet.erase( r ); // then r points to the next range
309 else // !joinPrev && !joinNext
311 const_cast< attr_t & >( r->myValue ) = theValue;
323 r = mySet.insert( r, RANGE( theIndex + 1, rValue )) - 1;
324 const_cast< attr_t & >( r->myValue ) = theValue;
328 else if ( r->my1st + rSize - 1 == theIndex ) // theIndex is last in the range
330 if ( rNext != mySet.end() && rNext->myValue == theValue ) // join to the next
336 mySet.insert( r, RANGE( theIndex, theValue ));
339 else // theIndex in the middle of the range
341 r = mySet.insert( r, RANGE( theIndex, theValue ));
342 r = mySet.insert( r, RANGE( theIndex + 1, rValue ));
346 }; // struct _RangeSet
349 typedef _Range< int > _ShapeIDRange; // sub-mesh ID range
350 typedef _Range< bool > _UsedRange; // range of used elements
352 typedef _RangeSet< _ShapeIDRange > TSubIDRangeSet;
353 typedef _RangeSet< _UsedRange > TUsedRangeSet;
354 typedef boost::dynamic_bitset<> TBitSet;
355 //typedef float TParam;
356 typedef double TParam;
358 //------------------------------------------------------------------------------------
360 * \brief Allocate SMDS_MeshElement's (SMDS_MeshCell's or SMDS_MeshNode's )
361 * and bind some attributes to elements:
362 * element ID, sub-shape ID, isMarked flag, parameters on shape
364 class SMDS_ElementChunk
366 SMDS_ElementFactory* myFactory; // holder of this chunk
367 SMDS_MeshElement* myElements; // array of elements
368 int my1stID; // ID of myElements[0]
369 TBitSet myMarkedSet; // mark some elements
370 TUsedRangeSet myUsedRanges; // ranges of used/unused elements
371 TSubIDRangeSet mySubIDRanges; // ranges of elements on the same sub-shape
372 int myMinSubID; // min sub-shape ID
373 int myMaxSubID; // max sub-shape ID
374 std::vector<TParam> myPositions; // UV parameters on shape: 2*param_t per an element
378 SMDS_ElementChunk( SMDS_ElementFactory* factory = 0, int id0 = 0 );
379 ~SMDS_ElementChunk();
381 //! Return an element by an index [0,ChunkSize()]
382 SMDS_MeshElement* Element(int index) { return & myElements[index]; }
384 //! Return an element by an index [0,ChunkSize()]
385 const SMDS_MeshElement* Element(int index) const { return & myElements[index]; }
387 //! Return ID of the first non-used element
388 int GetUnusedID() const;
390 //! Mark an element as used
391 void UseElement( const int index );
393 //! Mark an element as non-used
394 void Free( const SMDS_MeshElement* e );
396 //! Check if a given range holds used or non-used elements
397 static bool IsUsed( const _UsedRange& r ) { return r.myValue; }
399 //! Return index of an element in the chunk
400 int Index( const SMDS_MeshElement* e ) const { return e - myElements; }
402 //! Return ID of the 1st element in the chunk
403 int Get1stID() const { return my1stID; }
405 //! Return pointer to on-shape-parameters of a node
406 TParam* GetPositionPtr( const SMDS_MeshElement* node, bool allocate=false );
408 //! Return ranges of used/non-used elements
409 const TUsedRangeSet& GetUsedRanges() const { return myUsedRanges; }
410 const TUsedRangeSet& GetUsedRangesMinMax( bool& min, bool& max ) const
411 { min = false; max = true; return myUsedRanges; }
413 //! Return ranges of elements assigned to sub-shapes and min/max of sub-shape IDs
414 const TSubIDRangeSet& GetSubIDRangesMinMax( int& min, int& max ) const
415 { min = myMinSubID; max = myMaxSubID; return mySubIDRanges; }
417 //! Minimize allocated memory
421 void Dump() const; // debug
424 // Methods called by SMDS_MeshElement
426 int GetID( const SMDS_MeshElement* e ) const;
428 int GetVtkID( const SMDS_MeshElement* e ) const;
429 void SetVTKID( const SMDS_MeshElement* e, const vtkIdType id );
431 int GetShapeID( const SMDS_MeshElement* e ) const;
432 void SetShapeID( const SMDS_MeshElement* e, int shapeID ) const;
434 bool IsMarked ( const SMDS_MeshElement* e ) const;
435 void SetIsMarked( const SMDS_MeshElement* e, bool is );
437 SMDS_PositionPtr GetPosition( const SMDS_MeshNode* n ) const;
438 void SetPosition( const SMDS_MeshNode* n, const SMDS_PositionPtr& pos, int shapeID );
440 SMDS_Mesh* GetMesh() { return myFactory->myMesh; }
443 //------------------------------------------------------------------------------------
445 * \brief Iterator on elements in chunks
447 template< class ELEM_ITERATOR, class RANGE_SET >
448 struct _ChunkIterator : public ELEM_ITERATOR
450 typedef typename ELEM_ITERATOR::value_type element_type;
451 typedef SMDS_MeshElement::Filter* filter_ptr;
452 typedef typename RANGE_SET::attr_t attr_type;
453 typedef const RANGE_SET& (SMDS_ElementChunk::*get_rangeset_fun)(attr_type&, attr_type&) const;
455 const SMDS_MeshElement* myElement;
456 TIndexRanges myRanges;
458 const TChunkVector& myChunks;
460 get_rangeset_fun myGetRangeSetFun;
462 attr_type myMinValue;
463 attr_type myMaxValue;
465 size_t myNbElemsToReturn;
468 _ChunkIterator( const TChunkVector & theChunks,
469 get_rangeset_fun theGetRangeSetFun,
470 attr_type theAttrValue,
471 SMDS_MeshElement::Filter* theFilter,
472 size_t theNbElemsToReturn = -1):
475 myChunks( theChunks ),
477 myGetRangeSetFun( theGetRangeSetFun ),
478 myValue( theAttrValue ),
479 myFilter( theFilter ),
480 myNbElemsToReturn( theNbElemsToReturn ),
495 virtual element_type next()
497 element_type result = (element_type) myElement;
498 myNbReturned += bool( result );
501 if ( myNbReturned < myNbElemsToReturn )
502 while ( ! nextInRange() )
504 if ( ++myRangeIndex >= (int)myRanges.size() )
508 while ( ++myChunkIndex < (int)myChunks.size() &&
509 !getRangeSet().GetIndices( myValue, myRanges, &myMinValue, &myMaxValue ))
511 if ( myChunkIndex >= (int)myChunks.size() )
520 if ( myRangeIndex < (int)myRanges.size() )
522 std::pair< int, int > & range = myRanges[ myRangeIndex ];
523 while ( range.first < range.second && !myElement )
525 myElement = myChunks[ myChunkIndex ].Element( range.first++ );
526 if ( !(*myFilter)( myElement ))
533 const RANGE_SET& getRangeSet()
535 return ( myChunks[ myChunkIndex ].*myGetRangeSetFun )( myMinValue, myMaxValue );
537 }; // struct _ChunkIterator
540 template< class ElemIterator >
541 boost::shared_ptr< ElemIterator >
542 SMDS_ElementFactory::GetIterator( SMDS_MeshElement::Filter* filter,
543 size_t nbElemsToReturn )
545 typedef _ChunkIterator< ElemIterator, TUsedRangeSet > TChuckIterator;
546 return boost::make_shared< TChuckIterator >( myChunks,
547 & SMDS_ElementChunk::GetUsedRangesMinMax,
553 template< class ElemIterator >
554 boost::shared_ptr< ElemIterator >
555 SMDS_ElementFactory::GetShapeIterator( int shapeID, size_t nbElemsToReturn )
557 typedef _ChunkIterator< ElemIterator, TSubIDRangeSet > TChuckIterator;
558 return boost::make_shared< TChuckIterator >( myChunks,
559 & SMDS_ElementChunk::GetSubIDRangesMinMax,
561 new SMDS_MeshElement::NonNullFilter(),