/usr/include/deal.II/grid/grid_in.h is in libdeal.ii-dev 6.3.1-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 | //---------------------------------------------------------------------------
// $Id: grid_in.h 21158 2010-06-06 02:50:58Z bangerth $
// Version: $Name$
//
// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__grid_in_h
#define __deal2__grid_in_h
#include <base/config.h>
#include <base/exceptions.h>
#include <base/smartpointer.h>
#include <iostream>
#include <vector>
#include <string>
DEAL_II_NAMESPACE_OPEN
template <int dim> class Point;
template <int dim, int space_dim> class Triangulation;
template <int dim> class CellData;
class SubCellData;
/**
* This class implements an input mechanism for grid data. It allows to read a
* grid structure into a triangulation object. At present, UCD (unstructured
* cell data), DB Mesh, XDA, Gmsh, Tecplot, NetCDF and Cubit are supported as
* input format for grid data. Any numerical data after the block of geometric
* (vertex locations) and topological (how vertices form cells) information is
* ignored. Notice also that at the moment in the codimension 1 case only UCD
* and Gmsh format are accepted.
*
* Since the coarse mesh fed into a @p Triangulation object cannot have
* hanging nodes, strange things will happen if the input file has them. This
* is due to the fact that most mesh description formats do not store
* neighborship information between cells, so the grid reading functions have
* to regenerate it. They do so by checking whether two cells have a common
* face. If there are hanging nodes in a triangulation, adjacent cells have no
* common (complete) face, so the grid reader concludes that the adjacent
* cells have no neighbors along these faces and must therefore be at the
* boundary. In effect, an internal crack of the domain is introduced this
* way. Since such cases are very hard to detect, the library does not make
* any attempt to abort on such situations, and you will get a triangulation
* that probably does not do what you want. A solution to this problem is the
* PersistantTriangulation class.
*
* Note: if you experience unexpected problems with the use of this
* class, be sure to read the documentation right until the end, and
* also read the documentation of the GridReordering class.
*
* To read grid data, the triangulation to be fed with has to be empty.
* When giving a file which does not contain the assumed information or
* which does not keep to the right format, the state of the triangulation
* will be undefined afterwards. Upon input, only lines in one dimension
* and line and quads in two dimensions are accepted. All other cell types
* (e.g. triangles in two dimensions, quads and hexes in 3d) are rejected.
* The vertex and cell numbering in the input file, which
* need not be consecutively, is lost upon transfer to the triangulation
* object, since this one needs consecutively numbered elements.
*
* Material indicators are accepted to denote the material ID of cells and
* to denote boundary part indication for lines in 2D. Read the according
* sections in the documentation of the Triangulation class for
* further details.
*
*
* <h3>Supported input formats</h3>
*
* At present, the following input formats are supported:
* <ul>
* <li> @p UCD (unstructured cell data) format: this format is used
* for grid input as well as data output. If there are data vectors in
* the input file, they are ignored, as we are only interested in the
* grid in this class. The UCD format requires the vertices to be
* in following ordering: in 2d
* @verbatim
* 3-----2
* | |
* | |
* | |
* 0-----1
* @endverbatim
* and in 3d
* @verbatim
* 7-------6 7-------6
* /| | / /|
* / | | / / |
* / | | / / |
* 3 | | 3-------2 |
* | 4-------5 | | 5
* | / / | | /
* | / / | | /
* |/ / | |/
* 0-------1 0-------1
* @endverbatim
* Note, that this ordering is different from the deal.II numbering
* scheme, see the Triangulation class. The exact description of the
* UCD format can be found in the AVS Explorer manual (see
* http://www.avs.com). The @p UCD format can be read by the
* read_ucd() function.
*
* <li> <tt>DB mesh</tt> format: this format is used by the @p BAMG mesh
* generator (see
* http://www-rocq.inria.fr/gamma/cdrom/www/bamg/eng.htm. The
* documentation of the format in the @p BAMG manual is very
* incomplete, so we don't actually parse many of the fields of the
* output since we don't know their meaning, but the data that is read
* is enough to build up the mesh as intended by the mesh generator.
* This format can be read by the read_dbmesh() function.
*
* <li> @p XDA format: this is a rather simple format used by the MGF
* code. We don't have an exact specification of the format, but the reader
* can read in several example files. If the reader does not grok your files,
* it should be fairly simple to extend it.
*
* <li> <tt>Gmsh 1.0 mesh</tt> format: this format is used by the @p
* GMSH mesh generator (see http://www.geuz.org/gmsh/ ). The
* documentation in the @p GMSH manual explains how to generate meshes
* compatible with the deal.II library (i.e. quads rather than
* triangles). In order to use this format, Gmsh has to output the
* file in the old format 1.0. This is done adding the line
* "Mesh.MshFileVersion = 1" to the input file.
*
* <li> <tt>Gmsh 2.0 mesh</tt> format: this is a variant of the above format.
* The read_msh() function automatically determines whether an input file
* is version 1 or version 2.
*
* <li> <tt>Tecplot</tt> format: this format is used by @p TECPLOT and often
* serves as a basis for data exchange between different applications. Note,
* that currently only the ASCII format is supported, binary data cannot be
* read.
*
* <li> <tt>Cubit</tt> format: deal.II doesn't directly support importing from
* Cubit at this time. However, Cubit can export in UCD format using a simple
* plugin, and the resulting UCD file can then be read by this class. The
* plugin script can be found on the deal.II wiki page,
* http://sourceforge.net/apps/mediawiki/dealii/index.php?title=Mesh_Input_and_Output_Interfaces .
*
* There is also a little program, written by Jean-Paul Pelteret, that
* can be found in the <code>contrib/mesh_conversion</code> directory and that can
* convert Cubit ABAQUS files into UCD format that can be read in as
* discussed above. The program was designed with the intention of
* exporting geometries with complex boundary condition surfaces and
* multiple materials from Cubit - information which is currently not
* easily obtained through Cubit's python interface. Using the the
* program is simple: to use it, it needs to be built and run with the
* command
* @code
* ./convert_mesh <spatial_dimension> /path/to/input_file.inp /path/to/output_file.ucd
* @endcode.
* More information is available in the readme file included with the
* program. Note that the program's copyright remains with its author
* and that it is under a separate license than the rest of the
* library.
* </ul>
*
*
* <h3>Structure of input grid data. The GridReordering class</h3>
*
* It is your duty to use a correct numbering of vertices in the cell
* list, i.e. for lines in 1d, you have to first give the vertex with
* the lower coordinate value, then that with the higher coordinate
* value. For quadrilaterals in two dimensions, the vertex indices in
* the @p quad list have to be such that the vertices are numbered in
* counter-clockwise sense.
*
* In two dimensions, another difficulty occurs, which has to do with the sense
* of a quadrilateral. A quad consists of four lines which have a direction,
* which is per definitionem as follows:
* @verbatim
* 3-->--2
* | |
* ^ ^
* | |
* 0-->--1
* @endverbatim
* Now, two adjacent cells must have a vertex numbering such that the direction
* of the common side is the same. For example, the following two quads
* @verbatim
* 3---4---5
* | | |
* 0---1---2
* @endverbatim
* may be characterised by the vertex numbers <tt>(0 1 4 3)</tt> and
* <tt>(1 2 5 4)</tt>, since the middle line would get the direction <tt>1->4</tt>
* when viewed from both cells. The numbering <tt>(0 1 4 3)</tt> and
* <tt>(5 4 1 2)</tt> would not be allowed, since the left quad would give the
* common line the direction <tt>1->4</tt>, while the right one would want
* to use <tt>4->1</tt>, leading to an ambiguity. The Triangulation
* object is capable of detecting this special case, which can be
* eliminated by rotating the indices of the right quad by
* two. However, it would not know what to do if you gave the vertex
* indices <tt>(4 1 2 5)</tt>, since then it would have to rotate by one
* element or three, the decision which to take is not yet
* implemented.
*
* There are more ambiguous cases, where the triangulation may not
* know what to do at all without the use of sophisticated
* algorithms. Furthermore, similar problems exist in three space
* dimensions, where faces and lines have orientations that need to be
* taken care of.
*
* For this reason, the <tt>read_*</tt> functions of this class that read
* in grids in various input formats call the GridReordering
* class to bring the order of vertices that define the cells into an
* ordering that satisfies the requiremenets of the
* Triangulation class. Be sure to read the documentation of
* that class if you experience unexpected problems when reading grids
* through this class.
*
*
* <h3>Dealing with distorted mesh cells</h3>
*
* For each of the mesh reading functions, the last call is always to
* Triangulation::create_triangulation(). That function checks whether all the
* cells it creates as part of the coarse mesh are distorted or not (where
* distortion here means that the Jacobian of the mapping from the reference
* cell to the real cell has a non-positive determinant, i.e. the cell is
* pinched or twisted; see the entry on @ref GlossDistorted "distorted cells"
* in the glossary). If it finds any such cells, it throws an exception. This
* exception is not caught in the grid reader functions of the current class,
* and so will propagate through to the function that called it. There, you
* can catch and ignore the exception if you are certain that there is no harm
* in dealing with such cells. If you were not aware that your mesh had such
* cells, your results will likely be of dubious quality at best if you ignore
* the exception.
*
*
* @ingroup grid
* @ingroup input
* @author Wolfgang Bangerth, 1998, 2000, Luca Heltai, 2004, 2007
*/
template <int dim, int spacedim=dim>
class GridIn
{
public:
/**
* List of possible mesh input
* formats. These values are used
* when calling the function
* read() in order to determine
* the actual reader to be
* called.
*/
enum Format
{
/// Use GridIn::default_format stored in this object
Default,
/// Use read_ucd()
ucd,
/// Use read_dbmesh()
dbmesh,
/// Use read_xda()
xda,
/// Use read_msh()
msh,
/// Use read_netcdf()
netcdf,
/// Use read_tecplot()
tecplot
};
/**
* Constructor.
*/
GridIn ();
/**
* Attach this triangulation
* to be fed with the grid data.
*/
void attach_triangulation (Triangulation<dim,spacedim> &tria);
/**
* Read from the given stream. If
* no format is given,
* GridIn::Format::Default is
* used.
*/
void read (std::istream &in, Format format=Default);
/**
* Open the file given by the
* string and call the previous
* function read(). This function
* uses the PathSearch mechanism
* to find files. The file class
* used is <code>MESH</code>.
*/
void read (const std::string &in, Format format=Default);
/**
* Read grid data from an ucd file.
* Numerical data is ignored.
*/
void read_ucd (std::istream &in);
/**
* Read grid data from a file
* containing data in the DB mesh
* format.
*/
void read_dbmesh (std::istream &in);
/**
* Read grid data from a file
* containing data in the XDA
* format.
*/
void read_xda (std::istream &in);
/**
* Read grid data from an msh
* file, either version 1 or
* version 2 of that file
* format. The GMSH formats are
* documented at
* http://www.geuz.org/gmsh/ .
*
* @note The input function of
* deal.II does not distinguish
* between newline and other
* whitespace. Therefore, deal.II
* will be able to read files in
* a slightly more general format
* than Gmsh.
*/
void read_msh (std::istream &in);
/**
* Read grid data from a NetCDF
* file. The only data format
* currently supported is the
* <tt>TAU grid format</tt>.
*
* This function requires the
* library to be linked with the
* NetCDF library.
*/
void read_netcdf (const std::string &filename);
/**
* Read grid data from a file containing
* tecplot ASCII data. This also works in
* the absence of any tecplot
* installation.
*/
void read_tecplot (std::istream &in);
/**
* Returns the standard suffix
* for a file in this format.
*/
static std::string default_suffix (const Format format);
/**
* Return the enum Format for the
* format name.
*/
static Format parse_format (const std::string &format_name);
/**
* Return a list of implemented input
* formats. The different names are
* separated by vertical bar signs (<tt>`|'</tt>)
* as used by the ParameterHandler
* classes.
*/
static std::string get_format_names ();
/**
* Exception
*/
DeclException1 (ExcUnknownIdentifier,
std::string,
<< "The identifier <" << arg1 << "> as name of a "
<< "part in an UCD input file is unknown or the "
<< "respective input routine is not implemented."
<< "(Maybe the space dimension of triangulation and "
<< "input file do not match?");
/**
* Exception
*/
DeclException0 (ExcNoTriangulationSelected);
/**
* Exception
*/
DeclException2 (ExcInvalidVertexIndex,
int, int,
<< "Trying to access invalid vertex index " << arg2
<< " while creating cell " << arg1);
/**
* Exception
*/
DeclException0 (ExcInvalidDBMeshFormat);
/**
* Exception
*/
DeclException1 (ExcInvalidDBMESHInput,
std::string,
<< "The string <" << arg1 << "> is not recognized at the present"
<< " position of a DB Mesh file.");
/**
* Exception
*/
DeclException1 (ExcDBMESHWrongDimension,
int,
<< "The specified dimension " << arg1
<< " is not the same as that of the triangulation to be created.");
DeclException1 (ExcInvalidGMSHInput,
std::string,
<< "The string <" << arg1 << "> is not recognized at the present"
<< " position of a Gmsh Mesh file.");
DeclException1 (ExcGmshUnsupportedGeometry,
int,
<< "The Element Identifier <" << arg1 << "> is not "
<< "supported in the Deal.II Library.\n"
<< "Supported elements are: \n"
<< "ELM-TYPE\n"
<< "1 Line (2 nodes, 1 edge).\n"
<< "3 Quadrilateral (4 nodes, 4 edges).\n"
<< "5 Hexahedron (8 nodes, 12 edges, 6 faces).\n"
<< "15 Point (1 node, ignored when read)");
DeclException0 (ExcGmshNoCellInformation);
protected:
/**
* Store address of the triangulation to
* be fed with the data read in.
*/
SmartPointer<Triangulation<dim,spacedim>,GridIn<dim,spacedim> > tria;
/**
* This function can write the
* raw cell data objects created
* by the <tt>read_*</tt> functions in
* Gnuplot format to a
* stream. This is sometimes
* handy if one would like to see
* what actually was created, if
* it is known that the data is
* not correct in some way, but
* the Triangulation class
* refuses to generate a
* triangulation because of these
* errors. In particular, the
* output of this class writes
* out the cell numbers along
* with the direction of the
* faces of each cell. In
* particular the latter
* information is needed to
* verify whether the cell data
* objects follow the
* requirements of the ordering
* of cells and their faces,
* i.e. that all faces need to
* have unique directions and
* specified orientations with
* respect to neighboring cells
* (see the documentations to
* this class and the
* GridReordering class).
*
* The output of this function
* consists of vectors for each
* line bounding the cells
* indicating the direction it
* has with respect to the
* orientation of this cell, and
* the cell number. The whole
* output is in a form such that
* it can be read in by Gnuplot
* and generate the full plot
* without further ado by the
* user.
*/
static void debug_output_grid (const std::vector<CellData<dim> > &cells,
const std::vector<Point<spacedim> > &vertices,
std::ostream &out);
private:
/**
* Skip empty lines in the input
* stream, i.e. lines that
* contain either nothing or only
* whitespace.
*/
static void skip_empty_lines (std::istream &in);
/**
* Skip lines of comment that
* start with the indicated
* character (e.g. <tt>#</tt>)
* following the point where the
* given input stream presently
* is. After the call to this
* function, the stream is at the
* start of the first line after
* the comment lines, or at the
* same position as before if
* there were no lines of
* comments.
*/
static void skip_comment_lines (std::istream &in,
const char comment_start);
/**
* This function does the nasty work (due
* to very lax conventions and different
* versions of the tecplot format) of
* extracting the important parameters from
* a tecplot header, contained in the
* string @p header. The other variables
* are output variables, their value has no
* influence on the function execution..
*/
static void parse_tecplot_header(std::string &header,
std::vector<unsigned int> &tecplot2deal,
unsigned int &n_vars,
unsigned int &n_vertices,
unsigned int &n_cells,
std::vector<unsigned int> &IJK,
bool &structured,
bool &blocked);
/**
* Input format used by read() if
* no format is given.
*/
Format default_format;
};
/* -------------- declaration of explicit specializations ------------- */
#ifndef DOXYGEN
template <>
void
GridIn<2>::debug_output_grid (const std::vector<CellData<2> > &cells,
const std::vector<Point<2> > &vertices,
std::ostream &out);
template <>
void
GridIn<2,3>::debug_output_grid (const std::vector<CellData<2> > &cells,
const std::vector<Point<3> > &vertices,
std::ostream &out);
template <>
void
GridIn<3>::debug_output_grid (const std::vector<CellData<3> > &cells,
const std::vector<Point<3> > &vertices,
std::ostream &out);
#endif // DOXYGEN
DEAL_II_NAMESPACE_CLOSE
#endif
|