1 // Copyright (C) 2007-2019 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 : DriverCGNS_Write.cxx
23 // Created : Fri Aug 5 17:43:54 2011
24 // Author : Edward AGAPOV (eap)
26 #include "DriverCGNS_Write.hxx"
28 #include "SMDS_IteratorOnIterators.hxx"
29 #include "SMDS_MeshNode.hxx"
30 #include "SMDS_VolumeTool.hxx"
31 #include "SMESHDS_GroupBase.hxx"
32 #include "SMESHDS_Mesh.hxx"
33 #include "SMESH_Comment.hxx"
38 #if CGNS_VERSION < 3100
46 //================================================================================
48 * \brief Return interlace and type of CGNS element for the given SMDSAbs_EntityType
50 //================================================================================
52 const int* getInterlaceAndType( const SMDSAbs_EntityType smType,
53 CGNS_ENUMT( ElementType_t ) & cgType )
55 static vector< const int* > interlaces;
56 static vector< CGNS_ENUMT( ElementType_t )> cgTypes;
57 if ( interlaces.empty() )
59 interlaces.resize( SMDSEntity_Last, 0 );
60 cgTypes.resize( SMDSEntity_Last, CGNS_ENUMV( ElementTypeNull ));
62 static int ids[] = {0};
63 interlaces[SMDSEntity_0D] = ids;
64 cgTypes [SMDSEntity_0D] = CGNS_ENUMV( NODE );
67 static int ids[] = { 0, 1 };
68 interlaces[SMDSEntity_Edge] = ids;
69 cgTypes [SMDSEntity_Edge] = CGNS_ENUMV( BAR_2 );
72 static int ids[] = { 0, 1, 2 };
73 interlaces[SMDSEntity_Quad_Edge] = ids;
74 cgTypes [SMDSEntity_Quad_Edge] = CGNS_ENUMV( BAR_3 );
77 static int ids[] = { 0, 2, 1 };
78 interlaces[SMDSEntity_Triangle] = ids;
79 cgTypes [SMDSEntity_Triangle] = CGNS_ENUMV( TRI_3 );
82 static int ids[] = { 0, 2, 1, 5, 4, 3 };
83 interlaces[SMDSEntity_Quad_Triangle] = ids;
84 cgTypes [SMDSEntity_Quad_Triangle] = CGNS_ENUMV( TRI_6 );
85 interlaces[SMDSEntity_BiQuad_Triangle] = ids;
86 cgTypes [SMDSEntity_BiQuad_Triangle] = CGNS_ENUMV( TRI_6 );
89 static int ids[] = { 0, 3, 2, 1 };
90 interlaces[SMDSEntity_Quadrangle] = ids;
91 cgTypes [SMDSEntity_Quadrangle] = CGNS_ENUMV( QUAD_4 );
94 static int ids[] = { 0,3,2,1,7,6,5,4 };
95 interlaces[SMDSEntity_Quad_Quadrangle] = ids;
96 cgTypes [SMDSEntity_Quad_Quadrangle] = CGNS_ENUMV( QUAD_8 );
99 static int ids[] = { 0,3,2,1,7,6,5,4,8 };
100 interlaces[SMDSEntity_BiQuad_Quadrangle] = ids;
101 cgTypes [SMDSEntity_BiQuad_Quadrangle] = CGNS_ENUMV( QUAD_9 );
104 static int ids[] = { 0, 2, 1, 3 };
105 interlaces[SMDSEntity_Tetra] = ids;
106 cgTypes [SMDSEntity_Tetra] = CGNS_ENUMV( TETRA_4 );
109 static int ids[] = { 0,2,1,3,6,5,4,7,9,8 };
110 interlaces[SMDSEntity_Quad_Tetra] = ids;
111 cgTypes [SMDSEntity_Quad_Tetra] = CGNS_ENUMV( TETRA_10 );
114 static int ids[] = { 0,3,2,1,4 };
115 interlaces[SMDSEntity_Pyramid] = ids;
116 cgTypes [SMDSEntity_Pyramid] = CGNS_ENUMV( PYRA_5 );
119 static int ids[] = { 0,3,2,1,4,8,7,6,5,9,12,11,10 };
120 interlaces[SMDSEntity_Quad_Pyramid] = ids;
121 cgTypes [SMDSEntity_Quad_Pyramid] = CGNS_ENUMV( PYRA_13 );
124 static int ids[] = { 0,2,1,3,5,4 };
125 interlaces[SMDSEntity_Penta] = ids;
126 cgTypes [SMDSEntity_Penta] = CGNS_ENUMV( PENTA_6 );
129 static int ids[] = { 0,2,1,3,5,4,8,7,6,9,11,10,14,13,12 };
130 interlaces[SMDSEntity_Quad_Penta] = ids;
131 cgTypes [SMDSEntity_Quad_Penta] = CGNS_ENUMV( PENTA_15 );
134 static int ids[] = { 0,2,1,3,5,4,8,7,6,9,11,10,14,13,12,15,16,17 }; // TODO: check CGNS ORDER
135 interlaces[SMDSEntity_BiQuad_Penta] = ids;
136 cgTypes [SMDSEntity_BiQuad_Penta] = CGNS_ENUMV( PENTA_18 );
139 static int ids[] = { 0,3,2,1,4,7,6,5 };
140 interlaces[SMDSEntity_Hexa] = ids;
141 cgTypes [SMDSEntity_Hexa] = CGNS_ENUMV( HEXA_8 );
144 static int ids[] = { 0,3,2,1,4,7,6,5,11,10,9,8,12,15,14,13,19,18,17,16 };
145 interlaces[SMDSEntity_Quad_Hexa] = ids;
146 cgTypes [SMDSEntity_Quad_Hexa] = CGNS_ENUMV( HEXA_20 );
149 static int ids[] = { 0,3,2,1,4,7,6,5,11,10,9,8,12,15,14,13,19,18,17,16,
150 20, 24,23,22,21, 25, 26};
151 interlaces[SMDSEntity_TriQuad_Hexa] = ids;
152 cgTypes [SMDSEntity_TriQuad_Hexa] = CGNS_ENUMV( HEXA_27 );
155 cgTypes[SMDSEntity_Polygon] = CGNS_ENUMV( NGON_n );
156 cgTypes[SMDSEntity_Quad_Polygon] = CGNS_ENUMV( NGON_n );
157 cgTypes[SMDSEntity_Polyhedra] = CGNS_ENUMV( NFACE_n );
158 cgTypes[SMDSEntity_Hexagonal_Prism] = CGNS_ENUMV( NFACE_n );
161 cgType = cgTypes[ smType ];
162 return interlaces[ smType ];
165 //================================================================================
167 * \brief Cut off type of boundary condition from the group name
169 //================================================================================
171 CGNS_ENUMT( BCType_t ) getBCType( string& groupName )
173 CGNS_ENUMT( BCType_t ) bcType = CGNS_ENUMV( BCGeneral ); // default type
175 // boundary condition type starts from "BC"
176 size_t bcBeg = groupName.find("BC");
177 if ( bcBeg != string::npos )
179 for ( int t = 0; t < NofValidBCTypes; ++t )
181 CGNS_ENUMT( BCType_t ) type = CGNS_ENUMT( BCType_t )( t );
182 string typeName = cg_BCTypeName( type );
183 if ( typeName == &groupName[0] + bcBeg )
186 while ( bcBeg > 0 && isspace( bcBeg-1 ))
191 groupName = groupName.substr( 0, bcBeg-1 );
198 //================================================================================
200 * \brief Sortable face of a polyhedron
204 int _id; // id of NGON_n
205 vector< int > _nodes; // lowest node IDs used for sorting
207 TPolyhedFace( const SMDS_MeshNode** nodes, const int nbNodes, int ID):_id(ID)
210 for ( int i = 0; i < nbNodes; ++i )
211 ids.insert( nodes[i]->GetID() );
213 _nodes.resize( 3 ); // std::min( nbNodes, 4 )); hope 3 nodes is enough
214 set< int >::iterator idIt = ids.begin();
215 for ( size_t j = 0; j < _nodes.size(); ++j, ++idIt )
218 bool operator< (const TPolyhedFace& o ) const
220 return _nodes < o._nodes;
223 //================================================================================
225 * \brief Return CGNS id of an element
227 //================================================================================
229 cgsize_t cgnsID( const SMDS_MeshElement* elem,
230 const map< const SMDS_MeshElement*, cgsize_t >& elem2cgID )
232 map< const SMDS_MeshElement*, cgsize_t >::const_iterator e2id = elem2cgID.find( elem );
233 return ( e2id == elem2cgID.end() ? elem->GetID() : e2id->second );
238 //================================================================================
240 * \brief Write the mesh into the CGNS file
242 //================================================================================
244 Driver_Mesh::Status DriverCGNS_Write::Perform()
246 myErrorMessages.clear();
248 if ( !myMesh || myMesh->GetMeshInfo().NbElements() < 1 )
249 return addMessage( !myMesh ? "NULL mesh" : "Empty mesh (no elements)", /*fatal = */true );
252 if ( cg_open(myFile.c_str(), CG_MODE_MODIFY, &_fn) != CG_OK &&
253 cg_open(myFile.c_str(), CG_MODE_WRITE, &_fn) != CG_OK )
254 return addMessage( cg_get_error(), /*fatal = */true );
259 const int spaceDim = 3;
261 if ( myMesh->NbFaces() > 0 ) meshDim = 2;
262 if ( myMesh->NbVolumes() > 0 ) meshDim = 3;
264 if ( myMeshName.empty() )
267 if ( cg_nbases( _fn, &nbases) == CG_OK )
268 myMeshName = ( SMESH_Comment("Base_") << nbases+1 );
270 myMeshName = "Base_0";
273 if ( cg_base_write( _fn, myMeshName.c_str(), meshDim, spaceDim, &iBase ))
274 return addMessage( cg_get_error(), /*fatal = */true );
279 int nbCells = myMesh->NbEdges();
281 nbCells = myMesh->NbVolumes();
282 else if ( meshDim == 2 )
283 nbCells = myMesh->NbFaces();
285 cgsize_t size[9] = { myMesh->NbNodes(), nbCells, /*NBoundVertex=*/0, 0,0,0,0,0,0 };
287 if ( cg_zone_write( _fn, iBase, "SMESH_Mesh", size,
288 CGNS_ENUMV( Unstructured ), &iZone) != CG_OK )
289 return addMessage( cg_get_error(), /*fatal = */true );
291 // Map to store only elements whose an SMDS ID differs from a CGNS one
292 typedef map< const SMDS_MeshElement*, cgsize_t > TElem2cgIDMap;
293 vector< TElem2cgIDMap > elem2cgIDByEntity( SMDSEntity_Last );
294 TElem2cgIDMap::iterator elem2cgIDIter;
296 TElem2cgIDMap & n2cgID = elem2cgIDByEntity[ SMDSEntity_Node ];
301 vector< double > coords( myMesh->NbNodes() );
304 SMDS_NodeIteratorPtr nIt = myMesh->nodesIterator();
305 for ( int i = 0; nIt->more(); ++i ) coords[i] = nIt->next()->X();
306 if ( cg_coord_write( _fn, iBase, iZone, CGNS_ENUMV(RealDouble),
307 "CoordinateX", &coords[0], &iC) != CG_OK )
308 return addMessage( cg_get_error(), /*fatal = */true );
310 nIt = myMesh->nodesIterator();
311 for ( int i = 0; nIt->more(); ++i ) coords[i] = nIt->next()->Y();
312 if ( cg_coord_write( _fn, iBase, iZone, CGNS_ENUMV(RealDouble),
313 "CoordinateY", &coords[0], &iC) != CG_OK )
314 return addMessage( cg_get_error(), /*fatal = */true );
316 nIt = myMesh->nodesIterator();
317 for ( int i = 0; nIt->more(); ++i ) coords[i] = nIt->next()->Z();
318 if ( cg_coord_write( _fn, iBase, iZone, CGNS_ENUMV(RealDouble),
319 "CoordinateZ", &coords[0], &iC) != CG_OK )
320 return addMessage( cg_get_error(), /*fatal = */true );
322 // store CGNS ids of nodes
323 nIt = myMesh->nodesIterator();
324 for ( int i = 0; nIt->more(); ++i )
326 const SMDS_MeshElement* n = nIt->next();
327 if ( n->GetID() != i+1 )
328 n2cgID.insert( n2cgID.end(), make_pair( n, i+1 ));
334 cgsize_t cgID = 1, startID;
336 // write into a section all successive elements of one geom type
338 vector< cgsize_t > elemData;
339 SMDS_ElemIteratorPtr elemIt = myMesh->elementsIterator();
340 vector< SMDS_ElemIteratorPtr > elemItVec;
341 if ( _elementsByType )
343 // create an iterator returning all elements by type
344 for ( int type = SMDSEntity_Node + 1; type < SMDSEntity_Last; ++type )
346 if ( type == SMDSEntity_Ball )
347 continue; // not supported
348 elemIt = myMesh->elementEntityIterator( SMDSAbs_EntityType( type ));
349 if ( elemIt->more() )
350 elemItVec.push_back( elemIt );
352 typedef SMDS_IteratorOnIterators< const SMDS_MeshElement*,
353 vector< SMDS_ElemIteratorPtr > > TVecIterator;
354 elemIt.reset( new TVecIterator( elemItVec ));
357 const SMDS_MeshElement* elem = elemIt->next();
360 const SMDSAbs_EntityType elemType = elem->GetEntityType();
361 CGNS_ENUMT( ElementType_t ) cgType;
362 const int* interlace = getInterlaceAndType( elemType, cgType );
364 TElem2cgIDMap & elem2cgID = elem2cgIDByEntity[ elemType ];
369 if ( interlace ) // STANDARD elements
371 int cgnsNbNodes; // get nb nodes by element type, that can be less that elem->NbNodes()
372 cg_npe( cgType, &cgnsNbNodes );
375 for ( int i = 0; i < cgnsNbNodes; ++i )
376 elemData.push_back( cgnsID( elem->GetNode( interlace[i] ), n2cgID ));
377 if ( elem->GetID() != cgID )
378 elem2cgID.insert( elem2cgID.end(), make_pair( elem, cgID ));
380 elem = elemIt->more() ? elemIt->next() : 0;
382 while ( elem && elem->GetEntityType() == elemType );
384 else if ( elemType == SMDSEntity_Polygon ) // POLYGONS
387 elemData.push_back( elem->NbNodes() );
388 for ( int i = 0, nb = elem->NbNodes(); i < nb; ++i )
389 elemData.push_back( cgnsID( elem->GetNode(i), n2cgID ));
390 if ( elem->GetID() != cgID )
391 elem2cgID.insert( elem2cgID.end(), make_pair( elem, cgID ));
393 elem = elemIt->more() ? elemIt->next() : 0;
395 while ( elem && elem->GetEntityType() == elemType );
397 else if ( elemType == SMDSEntity_Quad_Polygon ) // QUADRATIC POLYGONS
398 do // write as linear NGON_n
400 elemData.push_back( elem->NbNodes() );
401 interlace = & SMDS_MeshCell::interlacedSmdsOrder( SMDSEntity_Quad_Polygon,
402 elem->NbNodes() )[0];
403 for ( int i = 0, nb = elem->NbNodes(); i < nb; ++i )
404 elemData.push_back( cgnsID( elem->GetNode( interlace[i] ), n2cgID ));
405 if ( elem->GetID() != cgID )
406 elem2cgID.insert( elem2cgID.end(), make_pair( elem, cgID ));
408 elem = elemIt->more() ? elemIt->next() : 0;
410 while ( elem && elem->GetEntityType() == elemType );
412 else if ( elemType == SMDSEntity_Polyhedra ||
413 elemType == SMDSEntity_Hexagonal_Prism) // POLYHEDRA
415 // to save polyhedrons after all
416 const SMDS_MeshInfo& meshInfo = myMesh->GetMeshInfo();
417 if ( meshInfo.NbPolyhedrons() == meshInfo.NbElements() - cgID + 1 )
418 break; // only polyhedrons remain
419 while ( elem && elem->GetEntityType() == elemType )
420 elem = elemIt->more() ? elemIt->next() : 0;
423 else // skip NOT SUPPORTED elements
425 while ( elemIt->more() )
427 elem = elemIt->next();
428 if ( elem->GetEntityType() != elemType )
433 SMESH_Comment sectionName( cg_ElementTypeName( cgType ));
434 sectionName << " " << startID << " - " << cgID-1;
436 if ( cg_section_write(_fn, iBase, iZone, sectionName.c_str(), cgType, startID,
437 cgID-1, /*nbndry=*/0, &elemData[0], &iSec) != CG_OK )
438 return addMessage( cg_get_error(), /*fatal = */true );
441 // Write polyhedral volumes
442 // -------------------------
444 if ( myMesh->GetMeshInfo().NbElements() > cgID-1 ) // polyhedra or hexagonal prisms remain
446 // the polyhedron (NFACE_n) is described as a set of signed face IDs,
447 // so first we are to write all polygones (NGON_n) bounding polyhedrons
449 vector< cgsize_t > faceData;
450 set< TPolyhedFace > faces;
451 set< TPolyhedFace >::iterator faceInSet;
452 vector<const SMDS_MeshNode *> faceNodesVec;
453 int nbPolygones = 0, faceID;
459 int nbPolyhTreated = 0;
461 TElem2cgIDMap * elem2cgID = 0;
462 TElem2cgIDMap & n2cgID = elem2cgIDByEntity[ SMDSEntity_Node ];
464 SMDS_ElemIteratorPtr elemIt = myMesh->elementsIterator();
465 while ( elemIt->more() )
467 elem = elemIt->next();
468 SMDSAbs_EntityType type = elem->GetEntityType();
469 if ( type == SMDSEntity_Polyhedra ||
470 type == SMDSEntity_Hexagonal_Prism )
474 vol.SetExternalNormal();
475 const int nbFaces = vol.NbFaces();
476 elemData.push_back( nbFaces );
477 for ( int iF = 0; iF < nbFaces; ++iF )
479 const int nbNodes = vol.NbFaceNodes( iF );
480 const SMDS_MeshNode** faceNodes = vol.GetFaceNodes( iF );
481 faceNodesVec.assign( faceNodes, faceNodes + nbNodes );
482 if (( elem = myMesh->FindElement( faceNodesVec, SMDSAbs_Face, /*noMedium=*/false)))
484 // a face of the polyhedron is present in the mesh
485 faceID = cgnsID( elem, elem2cgIDByEntity[ elem->GetEntityType() ]);
487 else if ( vol.IsFreeFace( iF ))
489 // the face is not shared by volumes
492 faceData.push_back( nbNodes );
493 for ( int i = 0; i < nbNodes; ++i )
494 faceData.push_back( cgnsID( faceNodes[i], n2cgID ));
498 TPolyhedFace face( faceNodes, nbNodes, cgID );
499 faceInSet = faces.insert( faces.end(), face );
500 if ( faceInSet->_id == cgID ) // the face encounters for the 1st time
504 faceData.push_back( nbNodes );
505 for ( int i = 0; i < nbNodes; ++i )
506 faceData.push_back( cgnsID( faceNodes[i], n2cgID ));
510 // the face encounters for the 2nd time; we hope it won't encounter once more,
511 // for that we can erase it from the set of faces
512 faceID = -faceInSet->_id;
513 faces.erase( faceInSet );
516 elemData.push_back( faceID );
521 if ( nbPolygones > 0 )
523 if ( cg_section_write(_fn, iBase, iZone, "Faces of Polyhedrons",
524 CGNS_ENUMV( NGON_n ), cgID - nbPolygones, cgID-1,
525 /*nbndry=*/0, &faceData[0], &iSec) != CG_OK )
526 return addMessage( cg_get_error(), /*fatal = */true );
529 if ( cg_section_write(_fn, iBase, iZone, "Polyhedrons",
530 CGNS_ENUMV( NFACE_n ), cgID, cgID+nbPolyhTreated-1,
531 /*nbndry=*/0, &elemData[0], &iSec) != CG_OK )
532 return addMessage( cg_get_error(), /*fatal = */true );
534 if ( !myMesh->GetGroups().empty() )
536 // store CGNS ids of polyhedrons
537 elem2cgID = &elem2cgIDByEntity[ SMDSEntity_Polyhedra ];
538 elemIt = myMesh->elementsIterator();
539 while ( elemIt->more() )
541 elem = elemIt->next();
542 if ( elem->GetEntityType() == SMDSEntity_Polyhedra )
544 if ( elem->GetID() != cgID )
545 elem2cgID->insert( elem2cgID->end(), make_pair( elem, cgID ));
550 } // write polyhedral volumes
553 // Write groups as boundary conditions
554 // ------------------------------------
556 const set<SMESHDS_GroupBase*>& groups = myMesh->GetGroups();
557 set<SMESHDS_GroupBase*>::const_iterator grpIt = groups.begin();
558 set< string > groupNames; groupNames.insert(""); // to avoid duplicated and empty names
559 for ( ; grpIt != groups.end(); ++grpIt )
561 const SMESHDS_GroupBase* group = *grpIt;
563 // write BC location (default is Vertex)
564 CGNS_ENUMT( GridLocation_t ) location = CGNS_ENUMV( Vertex );
565 if ( group->GetType() != SMDSAbs_Node )
569 switch ( group->GetType() ) {
570 #if CGNS_VERSION > 3130
571 case SMDSAbs_Volume: location = CGNS_ENUMV( CellCenter ); break;
573 case SMDSAbs_Volume: location = CGNS_ENUMV( FaceCenter ); break;
575 case SMDSAbs_Face: location = CGNS_ENUMV( FaceCenter ); break;
576 case SMDSAbs_Edge: location = CGNS_ENUMV( EdgeCenter ); break;
581 switch ( group->GetType() ) {
582 #if CGNS_VERSION > 3130
583 case SMDSAbs_Face: location = CGNS_ENUMV( CellCenter ); break;
585 case SMDSAbs_Face: location = CGNS_ENUMV( FaceCenter ); break;
587 case SMDSAbs_Edge: location = CGNS_ENUMV( EdgeCenter ); break;
592 #if CGNS_VERSION > 3130
593 location = CGNS_ENUMV( CellCenter ); break;
595 location = CGNS_ENUMV( EdgeCenter ); break;
601 // try to extract type of boundary condition from the group name
602 string name = group->GetStoreName();
603 CGNS_ENUMT( BCType_t ) bcType = getBCType( name );
604 if ( !groupNames.insert( name ).second ) // assure name uniqueness
609 newName = SMESH_Comment( name ) << "_" << index++;
611 while ( !groupNames.insert( newName ).second );
614 // write IDs of elements
615 vector< cgsize_t > pnts;
616 pnts.reserve( group->Extent() );
617 SMDS_ElemIteratorPtr elemIt = group->GetElements();
618 while ( elemIt->more() )
620 const SMDS_MeshElement* elem = elemIt->next();
621 pnts.push_back( cgnsID( elem, elem2cgIDByEntity[ elem->GetEntityType() ]));
623 if ( pnts.size() == 0 )
624 continue; // can't store empty group
626 if ( cg_boco_write( _fn, iBase, iZone, name.c_str(), bcType,
627 CGNS_ENUMV( PointList ), pnts.size(), &pnts[0], &iBC) != CG_OK )
628 return addMessage( cg_get_error(), /*fatal = */true);
631 if ( location != CGNS_ENUMV( Vertex ) || meshDim == 1 )
633 if ( cg_boco_gridlocation_write( _fn, iBase, iZone, iBC, location) != CG_OK )
634 return addMessage( cg_get_error(), /*fatal = */false);
640 //================================================================================
644 //================================================================================
646 DriverCGNS_Write::DriverCGNS_Write(): _fn(0), _elementsByType( false )
650 //================================================================================
652 * \brief Close the cgns file at destruction
654 //================================================================================
656 DriverCGNS_Write::~DriverCGNS_Write()