/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | foam-extend: Open Source CFD
\\ / O peration | Version: 4.0
\\ / A nd | Web: http://www.foam-extend.org
\\/ M anipulation | For copyright notice see file Copyright
-------------------------------------------------------------------------------
License
This file is part of foam-extend.
foam-extend is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
foam-extend is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with foam-extend. If not, see .
Description
Reads .msh file as written by Gmsh.
Needs surface elements on mesh to be present and aligned with outside faces
of the mesh. I.e. if the mesh is hexes, the outside faces need to be quads
Note: There is something seriously wrong with the ordering written in the
.msh file. Normal operation is to check the ordering and invert prisms
and hexes if found to be wrong way round.
Use the -keepOrientation to keep the raw information.
Note: The code now uses the element (cell,face) physical region id number
to create cell zones and faces zones (similar to
fluentMeshWithInternalFaces).
A use of the cell zone information, is for field initialization with the
"setFields" utility. see the classes: topoSetSource, zoneToCell.
\*---------------------------------------------------------------------------*/
#include "argList.H"
#include "polyMesh.H"
#include "foamTime.H"
#include "polyMesh.H"
#include "IFstream.H"
#include "cellModeller.H"
#include "repatchPolyTopoChanger.H"
#include "cellSet.H"
#include "faceSet.H"
using namespace Foam;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Element type numbers
static label MSHTRI = 2;
static label MSHQUAD = 3;
static label MSHTET = 4;
static label MSHPYR = 7;
static label MSHPRISM = 6;
static label MSHHEX = 5;
// Skips till end of section. Returns false if end of file.
bool skipSection(IFstream& inFile)
{
string line;
do
{
inFile.getLine(line);
if (!inFile.good())
{
return false;
}
}
while (line.size() < 4 || line.substr(0, 4) != "$End");
return true;
}
void renumber
(
const Map& mshToFoam,
labelList& labels
)
{
forAll(labels, labelI)
{
labels[labelI] = mshToFoam[labels[labelI]];
}
}
// Find face in pp which uses all vertices in meshF (in mesh point labels)
label findFace(const primitivePatch& pp, const labelList& meshF)
{
const Map& meshPointMap = pp.meshPointMap();
// meshF[0] in pp labels.
if (!meshPointMap.found(meshF[0]))
{
Warning<< "Not using gmsh face " << meshF
<< " since zero vertex is not on boundary of polyMesh" << endl;
return -1;
}
// Find faces using first point
const labelList& pFaces = pp.pointFaces()[meshPointMap[meshF[0]]];
// Go through all these faces and check if there is one which uses all of
// meshF vertices (in any order ;-)
forAll(pFaces, i)
{
label faceI = pFaces[i];
const face& f = pp[faceI];
// Count uses of vertices of meshF for f
label nMatched = 0;
forAll(f, fp)
{
if (findIndex(meshF, f[fp]) != -1)
{
nMatched++;
}
}
if (nMatched == meshF.size())
{
return faceI;
}
}
return -1;
}
// Same but find internal face. Expensive addressing.
label findInternalFace(const primitiveMesh& mesh, const labelList& meshF)
{
const labelList& pFaces = mesh.pointFaces()[meshF[0]];
forAll(pFaces, i)
{
label faceI = pFaces[i];
const face& f = mesh.faces()[faceI];
// Count uses of vertices of meshF for f
label nMatched = 0;
forAll(f, fp)
{
if (findIndex(meshF, f[fp]) != -1)
{
nMatched++;
}
}
if (nMatched == meshF.size())
{
return faceI;
}
}
return -1;
}
// Determine whether cell is inside-out by checking for any wrong-oriented
// face.
bool correctOrientation(const pointField& points, const cellShape& shape)
{
// Get centre of shape.
point cc(shape.centre(points));
// Get outwards pointing faces.
faceList faces(shape.faces());
forAll(faces, i)
{
const face& f = faces[i];
vector n(f.normal(points));
// Check if vector from any point on face to cc points outwards
if (((points[f[0]] - cc) & n) < 0)
{
// Incorrectly oriented
return false;
}
}
return true;
}
void storeCellInZone
(
const label regPhys,
const label cellI,
Map& physToZone,
labelList& zoneToPhys,
List >& zoneCells
)
{
Map::const_iterator zoneFnd = physToZone.find(regPhys);
if (zoneFnd == physToZone.end())
{
// New region. Allocate zone for it.
label zoneI = zoneCells.size();
zoneCells.setSize(zoneI+1);
zoneToPhys.setSize(zoneI+1);
Info<< "Mapping region " << regPhys << " to Foam cellZone "
<< zoneI << endl;
physToZone.insert(regPhys, zoneI);
zoneToPhys[zoneI] = regPhys;
zoneCells[zoneI].append(cellI);
}
else
{
// Existing zone for region
zoneCells[zoneFnd()].append(cellI);
}
}
// Reads points and map
void readPoints(IFstream& inFile, pointField& points, Map& mshToFoam)
{
Info<< "Starting to read points at line " << inFile.lineNumber() << endl;
string line;
inFile.getLine(line);
IStringStream lineStr(line);
label nVerts;
lineStr >> nVerts;
Info<< "Vertices to be read:" << nVerts << endl;
points.setSize(nVerts);
mshToFoam.resize(2*nVerts);
for (label pointI = 0; pointI < nVerts; pointI++)
{
label mshLabel;
scalar xVal, yVal, zVal;
string line;
inFile.getLine(line);
IStringStream lineStr(line);
lineStr >> mshLabel >> xVal >> yVal >> zVal;
point& pt = points[pointI];
pt.x() = xVal;
pt.y() = yVal;
pt.z() = zVal;
mshToFoam.insert(mshLabel, pointI);
}
Info<< "Vertices read:" << mshToFoam.size() << endl;
inFile.getLine(line);
IStringStream tagStr(line);
word tag(tagStr);
if (tag != "$ENDNOD" && tag != "$EndNodes")
{
FatalErrorIn("readPoints(..)")
<< "Did not find $ENDNOD tag on line "
<< inFile.lineNumber() << exit(FatalError);
}
Info<< endl;
}
// Reads physical names
void readPhysNames(IFstream& inFile, Map& physicalNames)
{
Info<< "Starting to read physical names at line " << inFile.lineNumber()
<< endl;
string line;
inFile.getLine(line);
IStringStream lineStr(line);
label nNames;
lineStr >> nNames;
Info<< "Physical names:" << nNames << endl;
physicalNames.resize(nNames);
for (label i = 0; i < nNames; i++)
{
label regionI;
string regionName;
string line;
inFile.getLine(line);
IStringStream lineStr(line);
label nSpaces = lineStr.str().count(' ');
if(nSpaces == 1)
{
lineStr >> regionI >> regionName;
Info<< " " << regionI << '\t'
<< string::validate(regionName) << endl;
}
else if(nSpaces == 2)
{
// >= Gmsh2.4 physical types has tag in front.
label physType;
lineStr >> physType >> regionI >> regionName;
if (physType == 1)
{
Info<< " " << "Line " << regionI << '\t'
<< string::validate(regionName) << endl;
}
else if (physType == 2)
{
Info<< " " << "Surface " << regionI << '\t'
<< string::validate(regionName) << endl;
}
else if (physType == 3)
{
Info<< " " << "Volume " << regionI << '\t'
<< string::validate(regionName) << endl;
}
}
physicalNames.insert(regionI, string::validate(regionName));
}
inFile.getLine(line);
IStringStream tagStr(line);
word tag(tagStr);
if (tag != "$EndPhysicalNames")
{
FatalErrorIn("readPhysicalNames(..)")
<< "Did not find $EndPhysicalNames tag on line "
<< inFile.lineNumber() << exit(FatalError);
}
Info<< endl;
}
// Reads cells and patch faces
void readCells
(
const bool version2Format,
const bool keepOrientation,
const pointField& points,
const Map& mshToFoam,
IFstream& inFile,
cellShapeList& cells,
labelList& patchToPhys,
List >& patchFaces,
labelList& zoneToPhys,
List >& zoneCells
)
{
Info<< "Starting to read cells at line " << inFile.lineNumber() << endl;
const cellModel& hex = *(cellModeller::lookup("hex"));
const cellModel& prism = *(cellModeller::lookup("prism"));
const cellModel& pyr = *(cellModeller::lookup("pyr"));
const cellModel& tet = *(cellModeller::lookup("tet"));
face triPoints(3);
face quadPoints(4);
labelList tetPoints(4);
labelList pyrPoints(5);
labelList prismPoints(6);
labelList hexPoints(8);
string line;
inFile.getLine(line);
IStringStream lineStr(line);
label nElems;
lineStr >> nElems;
Info<< "Cells to be read:" << nElems << endl << endl;
// Storage for all cells. Too big. Shrink later
cells.setSize(nElems);
label cellI = 0;
label nTet = 0;
label nPyr = 0;
label nPrism = 0;
label nHex = 0;
// From gmsh physical region to Foam patch
Map physToPatch;
// From gmsh physical region to Foam cellZone
Map physToZone;
for (label elemI = 0; elemI < nElems; elemI++)
{
string line;
inFile.getLine(line);
IStringStream lineStr(line);
label elmNumber, elmType, regPhys;
if (version2Format)
{
lineStr >> elmNumber >> elmType;
label nTags;
lineStr>> nTags;
label regElem, partition;
if (nTags == 3)
{
lineStr >> regPhys >> regElem >> partition;
}
else if (nTags == 2)
{
lineStr >> regPhys >> regElem;
}
else
{
regPhys = 0;
for (label i = 0; i < nTags; i++)
{
label dummy;
lineStr>> dummy;
}
}
}
else
{
label regElem, nNodes;
lineStr >> elmNumber >> elmType >> regPhys >> regElem >> nNodes;
}
// regPhys on surface elements is region number.
if (elmType == MSHTRI)
{
lineStr >> triPoints[0] >> triPoints[1] >> triPoints[2];
renumber(mshToFoam, triPoints);
Map::iterator regFnd = physToPatch.find(regPhys);
label patchI = -1;
if (regFnd == physToPatch.end())
{
// New region. Allocate patch for it.
patchI = patchFaces.size();
patchFaces.setSize(patchI + 1);
patchToPhys.setSize(patchI + 1);
Info<< "Mapping region " << regPhys << " to Foam patch "
<< patchI << endl;
physToPatch.insert(regPhys, patchI);
patchToPhys[patchI] = regPhys;
}
else
{
// Existing patch for region
patchI = regFnd();
}
// Add triangle to correct patchFaces.
patchFaces[patchI].append(triPoints);
}
else if (elmType == MSHQUAD)
{
lineStr
>> quadPoints[0] >> quadPoints[1] >> quadPoints[2]
>> quadPoints[3];
renumber(mshToFoam, quadPoints);
Map::iterator regFnd = physToPatch.find(regPhys);
label patchI = -1;
if (regFnd == physToPatch.end())
{
// New region. Allocate patch for it.
patchI = patchFaces.size();
patchFaces.setSize(patchI + 1);
patchToPhys.setSize(patchI + 1);
Info<< "Mapping region " << regPhys << " to Foam patch "
<< patchI << endl;
physToPatch.insert(regPhys, patchI);
patchToPhys[patchI] = regPhys;
}
else
{
// Existing patch for region
patchI = regFnd();
}
// Add quad to correct patchFaces.
patchFaces[patchI].append(quadPoints);
}
else if (elmType == MSHTET)
{
storeCellInZone
(
regPhys,
cellI,
physToZone,
zoneToPhys,
zoneCells
);
lineStr
>> tetPoints[0] >> tetPoints[1] >> tetPoints[2]
>> tetPoints[3];
renumber(mshToFoam, tetPoints);
cells[cellI++] = cellShape(tet, tetPoints);
nTet++;
}
else if (elmType == MSHPYR)
{
storeCellInZone
(
regPhys,
cellI,
physToZone,
zoneToPhys,
zoneCells
);
lineStr
>> pyrPoints[0] >> pyrPoints[1] >> pyrPoints[2]
>> pyrPoints[3] >> pyrPoints[4];
renumber(mshToFoam, pyrPoints);
cells[cellI++] = cellShape(pyr, pyrPoints);
nPyr++;
}
else if (elmType == MSHPRISM)
{
storeCellInZone
(
regPhys,
cellI,
physToZone,
zoneToPhys,
zoneCells
);
lineStr
>> prismPoints[0] >> prismPoints[1] >> prismPoints[2]
>> prismPoints[3] >> prismPoints[4] >> prismPoints[5];
renumber(mshToFoam, prismPoints);
cells[cellI] = cellShape(prism, prismPoints);
const cellShape& cell = cells[cellI];
if (!keepOrientation && !correctOrientation(points, cell))
{
Info<< "Inverting prism " << cellI << endl;
// Reorder prism.
prismPoints[0] = cell[0];
prismPoints[1] = cell[2];
prismPoints[2] = cell[1];
prismPoints[3] = cell[3];
prismPoints[4] = cell[4];
prismPoints[5] = cell[5];
cells[cellI] = cellShape(prism, prismPoints);
}
cellI++;
nPrism++;
}
else if (elmType == MSHHEX)
{
storeCellInZone
(
regPhys,
cellI,
physToZone,
zoneToPhys,
zoneCells
);
lineStr
>> hexPoints[0] >> hexPoints[1]
>> hexPoints[2] >> hexPoints[3]
>> hexPoints[4] >> hexPoints[5]
>> hexPoints[6] >> hexPoints[7];
renumber(mshToFoam, hexPoints);
cells[cellI] = cellShape(hex, hexPoints);
const cellShape& cell = cells[cellI];
if (!keepOrientation && !correctOrientation(points, cell))
{
Info<< "Inverting hex " << cellI << endl;
// Reorder hex.
hexPoints[0] = cell[4];
hexPoints[1] = cell[5];
hexPoints[2] = cell[6];
hexPoints[3] = cell[7];
hexPoints[4] = cell[0];
hexPoints[5] = cell[1];
hexPoints[6] = cell[2];
hexPoints[7] = cell[3];
cells[cellI] = cellShape(hex, hexPoints);
}
cellI++;
nHex++;
}
else
{
Info<< "Unhandled element " << elmType << " at line "
<< inFile.lineNumber() << endl;
}
}
inFile.getLine(line);
IStringStream tagStr(line);
word tag(tagStr);
if (tag != "$ENDELM" && tag != "$EndElements")
{
FatalErrorIn("readCells(..)")
<< "Did not find $ENDELM tag on line "
<< inFile.lineNumber() << exit(FatalError);
}
cells.setSize(cellI);
forAll(patchFaces, patchI)
{
patchFaces[patchI].shrink();
}
Info<< "Cells:" << endl
<< " total:" << cells.size() << endl
<< " hex :" << nHex << endl
<< " prism:" << nPrism << endl
<< " pyr :" << nPyr << endl
<< " tet :" << nTet << endl
<< endl;
if (cells.size() == 0)
{
FatalErrorIn("readCells(..)")
<< "No cells read from file " << inFile.name() << nl
<< "Does your file specify any 3D elements (hex=" << MSHHEX
<< ", prism=" << MSHPRISM << ", pyramid=" << MSHPYR
<< ", tet=" << MSHTET << ")?" << nl
<< "Perhaps you have not exported the 3D elements?"
<< exit(FatalError);
}
Info<< "CellZones:" << nl
<< "Zone\tSize" << endl;
forAll(zoneCells, zoneI)
{
zoneCells[zoneI].shrink();
const labelList& zCells = zoneCells[zoneI];
if (zCells.size())
{
Info<< " " << zoneI << '\t' << zCells.size() << endl;
}
}
Info<< endl;
}
// Simplified version of the function from createPatch utility.
void removeEmptyPatches(polyMesh& mesh)
{
Info<< "\n";
const polyBoundaryMesh& patches = mesh.boundaryMesh();
DynamicList nonEmptyPatches(patches.size());
forAll(patches, idx)
{
const polyPatch& pp = patches[idx];
if (pp.size() > 0)
{
nonEmptyPatches.append
(
pp.clone
(
patches,
nonEmptyPatches.size(),
pp.size(),
pp.start()
).ptr()
);
}
else
{
Info<< "Removing empty patch " << pp.name() << endl;
}
}
if (patches.size() != nonEmptyPatches.size())
{
nonEmptyPatches.shrink();
mesh.removeBoundary();
mesh.addPatches(nonEmptyPatches);
}
Info<< "\n";
}
// Main program:
int main(int argc, char *argv[])
{
argList::noParallel();
argList::validArgs.append(".msh file");
argList::validOptions.insert("keepOrientation", "");
# include "setRootCase.H"
# include "createTime.H"
fileName mshName(args.additionalArgs()[0]);
bool keepOrientation = args.optionFound("keepOrientation");
// Storage for points
pointField points;
Map mshToFoam;
// Storage for all cells.
cellShapeList cells;
// Map from patch to gmsh physical region
labelList patchToPhys;
// Storage for patch faces.
List > patchFaces(0);
// Map from cellZone to gmsh physical region
labelList zoneToPhys;
// Storage for cell zones.
List > zoneCells(0);
// Name per physical region
Map physicalNames;
// Version 1 or 2 format
bool version2Format = false;
IFstream inFile(mshName);
while (inFile.good())
{
string line;
inFile.getLine(line);
IStringStream lineStr(line);
word tag(lineStr);
if (tag == "$MeshFormat")
{
Info<< "Found $MeshFormat tag; assuming version 2 file format."
<< endl;
version2Format = true;
if (!skipSection(inFile))
{
break;
}
}
else if (tag == "$PhysicalNames")
{
readPhysNames(inFile, physicalNames);
}
else if (tag == "$NOD" || tag == "$Nodes")
{
readPoints(inFile, points, mshToFoam);
}
else if (tag == "$ELM" || tag == "$Elements")
{
readCells
(
version2Format,
keepOrientation,
points,
mshToFoam,
inFile,
cells,
patchToPhys,
patchFaces,
zoneToPhys,
zoneCells
);
}
else
{
Info<< "Skipping tag " << tag << " at line "
<< inFile.lineNumber()
<< endl;
if (!skipSection(inFile))
{
break;
}
}
}
label nValidCellZones = 0;
forAll(zoneCells, zoneI)
{
if (zoneCells[zoneI].size())
{
nValidCellZones++;
}
}
// Problem is that the orientation of the patchFaces does not have to
// be consistent with the outwards orientation of the mesh faces. So
// we have to construct the mesh in two stages:
// 1. define mesh with all boundary faces in one patch
// 2. use the read patchFaces to find the corresponding boundary face
// and repatch it.
// Create correct number of patches
// (but without any faces in it)
faceListList boundaryFaces(patchFaces.size());
wordList boundaryPatchNames(boundaryFaces.size());
forAll(boundaryPatchNames, patchI)
{
label physReg = patchToPhys[patchI];
Map::const_iterator iter = physicalNames.find(physReg);
if (iter != physicalNames.end())
{
boundaryPatchNames[patchI] = iter();
}
else
{
boundaryPatchNames[patchI] = word("patch") + name(patchI);
}
Info<< "Patch " << patchI << " gets name "
<< boundaryPatchNames[patchI] << endl;
}
Info<< endl;
wordList boundaryPatchTypes(boundaryFaces.size(), polyPatch::typeName);
word defaultFacesName = "defaultFaces";
word defaultFacesType = polyPatch::typeName;
wordList boundaryPatchPhysicalTypes
(
boundaryFaces.size(),
polyPatch::typeName
);
polyMesh mesh
(
IOobject
(
polyMesh::defaultRegion,
runTime.constant(),
runTime
),
xferMove(points),
cells,
boundaryFaces,
boundaryPatchNames,
boundaryPatchTypes,
defaultFacesName,
defaultFacesType,
boundaryPatchPhysicalTypes
);
repatchPolyTopoChanger repatcher(mesh);
// Now use the patchFaces to patch up the outside faces of the mesh.
// Get the patch for all the outside faces (= default patch added as last)
const polyPatch& pp = mesh.boundaryMesh()[mesh.boundaryMesh().size()-1];
// Storage for faceZones.
List > zoneFaces(patchFaces.size());
// Go through all the patchFaces and find corresponding face in pp.
forAll(patchFaces, patchI)
{
const DynamicList& pFaces = patchFaces[patchI];
Info<< "Finding faces of patch " << patchI << endl;
forAll(pFaces, i)
{
const face& f = pFaces[i];
// Find face in pp using all vertices of f.
label patchFaceI = findFace(pp, f);
if (patchFaceI != -1)
{
label meshFaceI = pp.start() + patchFaceI;
repatcher.changePatchID(meshFaceI, patchI);
}
else
{
// Maybe internal face? If so add to faceZone with same index
// - might be useful.
label meshFaceI = findInternalFace(mesh, f);
if (meshFaceI != -1)
{
zoneFaces[patchI].append(meshFaceI);
}
else
{
WarningIn(args.executable())
<< "Could not match gmsh face " << f
<< " to any of the interior or exterior faces"
<< " that share the same 0th point" << endl;
}
}
}
}
Info<< nl;
// Face zones
label nValidFaceZones = 0;
Info<< "FaceZones:" << nl
<< "Zone\tSize" << endl;
forAll(zoneFaces, zoneI)
{
zoneFaces[zoneI].shrink();
const labelList& zFaces = zoneFaces[zoneI];
if (zFaces.size())
{
nValidFaceZones++;
Info<< " " << zoneI << '\t' << zFaces.size() << endl;
}
}
Info<< endl;
//Get polyMesh to write to constant
runTime.setTime(instant(runTime.constant()), 0);
repatcher.repatch();
List cz;
List fz;
// Construct and add the zones. Note that cell ordering does not change
// because of repatch() and neither does internal faces so we can
// use the zoneCells/zoneFaces as is.
if (nValidCellZones > 0)
{
cz.setSize(nValidCellZones);
nValidCellZones = 0;
forAll(zoneCells, zoneI)
{
if (zoneCells[zoneI].size())
{
label physReg = zoneToPhys[zoneI];
Map::const_iterator iter = physicalNames.find(physReg);
word zoneName = "cellZone_" + name(zoneI);
if (iter != physicalNames.end())
{
zoneName = iter();
}
Info<< "Writing zone " << zoneI << " to cellZone "
<< zoneName << " and cellSet"
<< endl;
cellSet cset(mesh, zoneName, labelHashSet(zoneCells[zoneI]));
cset.write();
cz[nValidCellZones] = new cellZone
(
zoneName,
zoneCells[zoneI],
nValidCellZones,
mesh.cellZones()
);
nValidCellZones++;
}
}
}
if (nValidFaceZones > 0)
{
fz.setSize(nValidFaceZones);
nValidFaceZones = 0;
forAll(zoneFaces, zoneI)
{
if (zoneFaces[zoneI].size())
{
label physReg = zoneToPhys[zoneI];
Map::const_iterator iter = physicalNames.find(physReg);
word zoneName = "faceZone_" + name(zoneI);
if (iter != physicalNames.end())
{
zoneName = iter();
}
Info<< "Writing zone " << zoneI << " to faceZone "
<< zoneName << " and faceSet"
<< endl;
faceSet fset(mesh, zoneName, labelHashSet(zoneFaces[zoneI]));
fset.write();
fz[nValidFaceZones] = new faceZone
(
zoneName,
zoneFaces[zoneI],
boolList(zoneFaces[zoneI].size(), true),
nValidFaceZones,
mesh.faceZones()
);
nValidFaceZones++;
}
}
}
if (cz.size() || fz.size())
{
mesh.addZones(List(0), fz, cz);
}
removeEmptyPatches(mesh);
mesh.write();
Info<< "End\n" << endl;
return 0;
}
// ************************************************************************* //