/usr/include/deal.II/grid/grid_out.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 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 | //---------------------------------------------------------------------------
// $Id: grid_out.h 20762 2010-03-09 16:08:06Z bangerth $
// Version: $Name$
//
// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 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_out_h
#define __deal2__grid_out_h
#include <base/config.h>
#include <base/exceptions.h>
#include <base/point.h>
#include <grid/tria.h>
#include <fe/mapping.h>
#include <string>
DEAL_II_NAMESPACE_OPEN
class ParameterHandler;
template <int dim, int spacedim> class Triangulation;
template <int dim, int spacedim> class Mapping;
/**
* Within this namespace, we define several structures that are used
* to describe flags that can be given to grid output routines to
* modify the default outfit of the grids written into a file. See the
* different subclasses and the documentation of the GridOut
* class for more details.
*
* @ingroup output
*/
namespace GridOutFlags
{
/**
* Flags for grid output in OpenDX format.
*
* @ingroup output
*/
struct DX
{
/**
* Write cells.
*/
bool write_cells;
/**
* Write faces.
*/
bool write_faces;
/**
* Write field with diameters.
*/
bool write_diameter;
/**
* Write field with area/volume.
*/
bool write_measure;
/**
* Write all faces, including
* interior faces. If
* <tt>false</tt>, only
* boundary faces are written.
*/
bool write_all_faces;
/**
* Constructor.
*/
DX (const bool write_cells = true,
const bool write_faces = false,
const bool write_diameter = false,
const bool write_measure = false,
const bool write_all_faces = true);
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
/**
* Flags describing the details of
* output in MSH format.
*
* @ingroup output
*/
struct Msh
{
/**
* When writing a mesh, write boundary
* faces explicitly if their boundary
* indicator is not the default
* boundary indicator, which is zero.
* This is necessary if you later
* want to re-read the grid and want
* to get the same boundary indicators
* for the different parts of the
* boundary of the triangulation.
*
* It is not necessary if you only want
* to write the triangulation to
* view or print it.
*
* Default: @p false.
*/
bool write_faces;
/**
* When writing a mesh, write boundary
* lines explicitly if their boundary
* indicator is not the default
* boundary indicator, which is zero.
* This is necessary if you later
* want to re-read the grid and want
* to get the same boundary indicators
* for the different parts of the
* boundary of the triangulation.
*
* It is not necessary if you only want
* to write the triangulation to
* view or print it.
*
* This is used only if
* <tt>dim==3</tt>, and ignored
* in all other cases.
*
* Default: @p false.
*/
bool write_lines;
/**
* Constructor.
*/
Msh (const bool write_faces = false,
const bool write_lines = false);
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
/**
* Flags describing the details of
* output in UCD format.
*
* @ingroup output
*/
struct Ucd
{
/**
* Write a comment at the
* beginning of the file
* stating the date of creation
* and some other data. While
* this is supported by the UCD
* format (and the AVS
* program), some other
* programs get confused by
* this, so the default is to
* not write a
* preamble. However, a
* preamble can be written
* using this flag.
*
* Default: <code>false</code>.
*/
bool write_preamble;
/**
* When writing a mesh, write boundary
* faces explicitly if their boundary
* indicator is not the default
* boundary indicator, which is zero.
* This is necessary if you later
* want to re-read the grid and want
* to get the same boundary indicators
* for the different parts of the
* boundary of the triangulation.
*
* It is not necessary if you only want
* to write the triangulation to
* view or print it.
*
* Default: @p false.
*/
bool write_faces;
/**
* When writing a mesh, write boundary
* lines explicitly if their boundary
* indicator is not the default
* boundary indicator, which is zero.
* This is necessary if you later
* want to re-read the grid and want
* to get the same boundary indicators
* for the different parts of the
* boundary of the triangulation.
*
* It is not necessary if you only want
* to write the triangulation to
* view or print it.
*
* This directive is ignored if
* <tt>dim!=3</tt>.
*
* Default: @p false.
*/
bool write_lines;
/**
* Constructor.
*/
Ucd (const bool write_preamble = false,
const bool write_faces = false,
const bool write_lines = false);
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
/**
* Flags describing the details of
* output in GNUPLOT format.
*
* @ingroup output
*/
struct Gnuplot
{
/**
* Write the number of each cell into
* the output file before starting
* with the lines it is composed of,
* as a comment. This might be useful
* if you want to find out details
* about the grid, for example the
* position of cells of which you
* know the number. It enlarges
* the size of the output
* significantly, however.
*
* Default: @p false.
*/
bool write_cell_numbers;
/**
* Based on the vertices of the
* face and
* <tt>n_boundary_face_points</tt>
* additional points a tensor
* product mesh (tranformed to
* the real space) of
* $(n_boundary_face_points+2)^{dim-1}$
* points is plotted on each
* boundary face.
*/
unsigned int n_boundary_face_points;
/**
* Flag. If true also inner
* cells are plotted with
* curved boundaries. This is
* useful when for e.g.
* MappingQEulerian with
* <code>n_boundary_face_points>0</code>.
*/
bool curved_inner_cells;
/**
* Constructor.
*/
Gnuplot (const bool write_cell_number = false,
const unsigned int n_boundary_face_points = 2,
const bool curved_inner_cells = false);
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
/**
* Flags describing the details of
* output for encapsulated postscript.
* In this structure, the flags common
* to all dimensions are listed. Flags
* which are specific to one space
* dimension only are listed in derived
* classes.
*
* By default, the size of the picture
* is scaled such that the width equals
* 300 units.
*
* @ingroup output
*/
struct EpsFlagsBase
{
/**
* Enum denoting the possibilities
* whether the scaling should be done
* such that the given @p size equals
* the width or the height of
* the resulting picture.
*/
enum SizeType {
width, height
};
/**
* See above. Default is @p width.
*/
SizeType size_type;
/**
* Width or height of the output
* as given in postscript units
* This usually is given by the
* strange unit 1/72 inch. Whether
* this is height or width is
* specified by the flag
* @p size_type.
*
* Default is 300.
*/
unsigned int size;
/**
* Width of a line in postscript
* units. Default is 0.5.
*/
double line_width;
/**
* Should lines with a set
* @p user_flag be drawn in a
* different color (red)?
*/
bool color_lines_on_user_flag;
/**
* This is the number of
* points on a boundary face,
* that are ploted
* additionally to the
* vertices of the face.
*
* This is used if the
* mapping used is not the
* standard @p MappingQ1
* mapping.
*/
unsigned int n_boundary_face_points;
/**
* Should lines be colored
* according to their
* refinement level? This
* overrides
* color_lines_on_user_flag for
* all levels except level 0.
* Colors are: level 0: black,
* other levels: rainbow scale
* from blue to red.
*/
bool color_lines_level;
/**
* Constructor.
*/
EpsFlagsBase (const SizeType size_type = width,
const unsigned int size = 300,
const double line_width = 0.5,
const bool color_lines_on_user_flag = false,
const unsigned int n_boundary_face_points = 2,
const bool color_lines_level = false);
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
/**
* Flags describing the details of
* output for encapsulated postscript
* for all dimensions not explicitly
* specialized below. Some flags that
* are common to all dimensions are
* listed in the base class.
*
* This class does not actually
* exist, we only here declare the
* general template and declare
* explicit specializations below.
*
* @ingroup output
*/
template <int dim>
struct Eps
{};
/**
* Flags specific to the output of
* grids in one space dimensions.
*
* @ingroup output
*/
template <>
struct Eps<1> : public EpsFlagsBase
{
/**
* Constructor.
*/
Eps (const SizeType size_type = width,
const unsigned int size = 300,
const double line_width = 0.5,
const bool color_lines_on_user_flag = false,
const unsigned int n_boundary_face_points = 2);
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
/**
* Flags specific to the output of
* grids in two space dimensions.
*
* @ingroup output
*/
template <>
struct Eps<2> : public EpsFlagsBase
{
/**
* If this flag is set, then we
* place the number of the cell
* into the middle of each
* cell. The default value is
* to not do this.
*
* The format of the cell
* number written is
* <tt>level.index</tt>, or simply
* @p index, depending on the
* value of the following flag.
*/
bool write_cell_numbers;
/**
* If the cell numbers shall be
* written, using the above
* flag, then the value of this
* flag determines whether the
* format shall be
* <tt>level.index</tt>, or simply
* @p index. If @p true, the
* first format is
* taken. Default is @p true.
*
* The flag has obviously no
* effect if
* @p write_cell_numbers is
* @p false.
*/
bool write_cell_number_level;
/**
* Vertex numbers can be
* written onto the
* vertices. This is controled
* by the following
* flag. Default is @p false.
*/
bool write_vertex_numbers;
/**
* Constructor.
*/
Eps (const SizeType size_type = width,
const unsigned int size = 300,
const double line_width = 0.5,
const bool color_lines_on_user_flag = false,
const unsigned int n_boundary_face_points = 2,
const bool write_cell_numbers = false,
const bool write_cell_number_level = true,
const bool write_vertex_numbers = false,
const bool color_lines_level = false);
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
/**
* Flags specific to the output of
* grids in three space dimensions.
*
* @ingroup output
*/
template <>
struct Eps<3> : public EpsFlagsBase
{
/**
* Angle of the line origin-viewer
* against the z-axis in degrees.
*
* Default is the Gnuplot-default
* of 60.
*/
double azimut_angle;
/**
* Angle by which the viewers
* position projected onto the
* x-y-plane is rotated around
* the z-axis, in positive sense
* when viewed from above. The
* unit are degrees, and zero
* equals a position above or below
* the negative y-axis.
*
* Default is the Gnuplot-default
* of 30.
*/
double turn_angle;
/**
* Constructor.
*/
Eps (const SizeType size_type = width,
const unsigned int size = 300,
const double line_width = 0.5,
const bool color_lines_on_user_flag = false,
const unsigned int n_boundary_face_points = 2,
const double azimut_angle = 60,
const double turn_angle = 30);
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
/**
* Flags for XFig output.
*
* @ingroup output
*/
struct XFig
{
/**
* Draw boundary lines. Default is true.
*/
bool draw_boundary;
/**
* Change color depending on
* level. Default is false, therefore,
* color is coded by material or
* boundary id.
*/
bool level_color;
/**
* Code level to depth. Default is
* true. If false, color depends on
* material or boundary id.
*
* Depth of the object is 900-level, if
* this value is true.
*/
bool level_depth;
/**
* Additional points for curved
* boundaries. Default is none.
*/
unsigned int n_boundary_face_points;
/**
* Scaling of graph. The
* default is a unit length of
* one inch.
*/
Point<2> scaling;
/**
* Offset of the graph. Before
* scaling, the coordinates are
* shifted by this
* value. Default is zero in
* each direction.
*/
Point<2> offset;
/**
* Style for filling cells. Default is
* solid fill (20). This value is
* forwarded unchanged into the
* corresponding field
* <tt>fill_style</tt> of the polyline
* object of XFig.
*/
int fill_style;
/**
* Style for drawing border lines of
* polygons. Defaults to solid (0) and
* is forwarded to XFig.
*/
int line_style;
/**
* Thickness of border lines of
* polygons. Default is 1.
*
* Set this to zero to avoid
* border lines for very fine
* meshes.
*/
int line_thickness;
/**
* Style for drawing lines at the
* boundary. Defaults to solid (0).
*/
int boundary_style;
/**
* Thickness of boundary
* lines. Default is 3.
*/
int boundary_thickness;
/**
* Constructor.
*/
XFig();
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
};
}
/**
* This class provides a means to output a triangulation to a file in
* different formats. See the enum GridOut::OutputFormat for a list of formats
* and the corresponding output function names.
*
* Usage is simple: either you use the direct form
* @verbatim
* ofstream output_file("some_filename");
* GridOut().write_gnuplot (tria, output_file);
* @endverbatim
* if you know which format you want to have, or if you want the format to be
* a runtime parameter, you can write
* @verbatim
* GridOut::OutputFormat grid_format =
* GridOut::parse_output_format(get_format_name_from_somewhere());
* ofstream output_file("some_filename" + GridOut::default_suffix(output_format));
* GridOut().write (tria, output_file, output_format);
* @endverbatim
* The function <tt>get_output_format_names()</tt> provides a list of possible names of
* output formats in a string that is understandable by the ParameterHandler class.
*
* Note that here, we have created an unnamed object of type GridOut and called
* one of its <tt>write_*</tt> functions. This looks like as if the respective function
* could really be made @p static. This was not done in order to allow for
* parameters to be passed to the different output functions in a way compatible
* with the scheme of allowing the right output format to be selected at run-time
* through the generic @p write function.
*
* In order to explain this, consider each function had one or more additional
* parameters giving the details of output, for example position of the spectator
* for 3d meshed, line thicknesses, etc. While this would allow each output
* function any flexibility it needs, it would not allow us to use the generic
* function @p write which is given a parameter determining the output format,
* since it is impractical to give it a list of parameters for each and every
* output format supported which it may then pass on to the respective output
* function.
*
* Rather, we have chosen to let each object of this class
* GridOut have a set of parameters for each supported output
* format. These are collected in structures GridOutFlags::Eps(),
* GridOutFlags::Gnuplot(), etc declared in the GridOutFlags
* namespace, and you can set your preferred flags like this:
* @verbatim
* GridOut grid_out;
* GridOutFlags::Ucd ucd_flags;
* ... // set some fields in ucd_flags
* grid_out.set_flags (ucd_flags);
* ...
* ... // write some file with data_out
* @endverbatim
* The respective output function then use the so-set flags. By default, they
* are set to reasonable values as described above and in the documentation
* of the different flags structures. Resetting the flags can
* be done by calling <tt>grid_out.set_flags (GridOutFlags::Ucd());</tt>, since the
* default constructor of each of the flags structures sets the parameters
* to their initial values.
*
* The advantage of this approach is that it is possible to change the flags
* of one or more output formats according to your needs and later use the
* generic @p write function; the actual output function then called will
* use the flags as set before.
*
* Note that some of the structures describing the flags of the different
* output formats are empty since the respective format does not support
* any flags. The structure and the @p set_flags function are provided
* anyway. Note also that some of the structures may differ between the
* dimensions supported by this class; they then have a template parameter,
* as usual.
*
* @ingroup grid
* @ingroup output
* @author Wolfgang Bangerth, Guido Kanschat, Luca Heltai, 1999, 2003, 2006; postscript format based on an implementation by Stefan Nauber, 1999
*/
class GridOut
{
public:
/**
* Declaration of a name for each
* of the different output
* formats. These are used by the
* generic output function
* write() to determine the
* actual output format.
*/
enum OutputFormat
{
/// Do nothing in write()
none,
/// write() calls write_dx()
dx,
/// write() calls write_gnuplot()
gnuplot,
/// write() calls write_eps()
eps,
/// write() calls write_ucd()
ucd,
/// write() calls write_xfig()
xfig,
/// write() calls write_msh()
msh
};
/**
* Constructor.
*/
GridOut ();
/**
* Write triangulation in OpenDX
* format.
*
* Cells or faces are written
* together with their level and
* their material id or boundary
* indicator, resp.
*
* Not implemented for the
* codimension one case.
*/
template <int dim>
void write_dx (const Triangulation<dim> &tria,
std::ostream &out) const;
/**
* Write the triangulation in the
* gnuplot format.
*
* In GNUPLOT format, each cell
* is written as a sequence of
* its confining lines. Apart
* from the coordinates of the
* line's end points, the level
* and the material of the cell
* are appended to each line of
* output. Therefore, if you let
* GNUPLOT draw a 2d grid as a 3d
* plot, you will see more
* refined cells being raised
* against cells with less
* refinement. Also, if you draw
* a cut through a 3d grid, you
* can extrude the refinement
* level in the direction
* orthogonal to the cut
* plane. The same can be done
* with the material id, which is
* plotted after the level.
*
* A more useful application of
* this feature is the following:
* if you use the GNUPLOT
* command (for a 2d grid here)
* @verbatim
* splot [:][:][2.5:3.5] "grid_file.gnuplot" *
* @endverbatim
* then the
* whole x- and y-range will be
* plotted, i.e. the whole grid,
* but only those lines with a
* z-value between 2.5 and
* 3.5. Since the z-values were
* chosen to be the level to
* which a cell belongs, this
* results in a plot of those
* cells only that belong to
* level 3 in this example. This
* way, it is easy to produce
* plots of the different levels
* of grid.
*
* @p mapping is a pointer to a
* mapping used for the
* transformation of cells at the
* boundary. If zero, then use
* standard Q1 mapping.
*
* Names and values of additional
* flags controlling the output
* can be found in the
* documentation of the
* GridOutFlags::Gnuplot() class.
*
* Not implemented for the
* codimension one case.
*/
template <int dim>
void write_gnuplot (const Triangulation<dim> &tria,
std::ostream &out,
const Mapping<dim> *mapping=0) const;
/**
* Write the triangulation in the
* msh format.
*
* Msh
* is the format used by Gmsh and it is
* described in the gmsh
* user's guide. Besides the
* usual output of the grid
* only, you can decide through
* additional flags (see below,
* and the documentation of the
* GridOutFlags::Msh() class)
* whether boundary faces with
* non-zero boundary indicator
* shall be written to the file
* explicitly. This is useful,
* if you want to re-read the
* grid later on, since
* <tt>deal.II</tt> sets the boundary
* indicator to zero by default;
* therefore, to obtain the
* same triangulation as before,
* you have to specify faces
* with differing boundary
* indicators explicitly, which
* is done by this flag.
*
* Names and values of further
* flags controlling the output
* can be found in the
* documentation of the
* GridOut::Msh() class.
*
* Works also in the
* codimension one case.
*/
template <int dim, int spacedim>
void write_msh (const Triangulation<dim,spacedim> &tria,
std::ostream &out) const;
/**
* Write the triangulation in the
* ucd format.
*
* UCD (unstructured cell data)
* is the format used by AVS and
* some other programs. It is
* described in the AVS
* developer's guide. Besides the
* usual output of the grid
* only, you can decide through
* additional flags (see below,
* and the documentation of the
* GridOutFlags::Ucd() class)
* whether boundary faces with
* non-zero boundary indicator
* shall be written to the file
* explicitly. This is useful,
* if you want to re-read the
* grid later on, since
* <tt>deal.II</tt> sets the boundary
* indicator to zero by default;
* therefore, to obtain the
* same triangulation as before,
* you have to specify faces
* with differing boundary
* indicators explicitly, which
* is done by this flag.
*
* Names and values of further
* flags controlling the output
* can be found in the
* documentation of the
* GridOut::Ucd() class.
*
* Works also for the
* codimension one case.
*/
template <int dim, int spacedim>
void write_ucd (const Triangulation<dim,spacedim> &tria,
std::ostream &out) const;
/**
* Write the triangulation in the
* encapsulated postscript format.
*
* In this format, each line of
* the triangulation is written
* separately. We scale the
* picture such that either
* x-values or y-values range
* between zero and a fixed
* size. The other axis is scaled
* by the same factor. Which axis
* is taken to compute the scale
* and the size of the box it
* shall fit into is determined
* by the output flags (see
* below, and the documentation
* of the GridOutFlags::Eps()
* class).
*
* The bounding box is close to
* the triangulation on all four
* sides, without an extra
* frame. The line width is
* chosen to be 0.5 by default,
* but can be changed. The line
* width is to be compared with
* the extension of the picture,
* of which the default is 300.
*
* The flag
* @p color_lines_on_user_flag
* allows to draw lines with the
* @p user_flag set to be drawn in
* red. The colors black and red
* are defined as @p b and @p r in
* the preamble of the output
* file and can be changed there
* according to need.
*
* @p mapping is a pointer to a
* mapping used for the
* transformation of cells at the
* boundary. If zero, then use
* standard Q1 mapping.
*
* Names and values of additional
* flags controlling the output
* can be found in the
* documentation of the
* GridOutFlags::Eps()
* class. Especially the
* viewpoint for three
* dimensional grids is of
* importance here.
*
* Not implemented for the
* codimension one case.
*/
template <int dim>
void write_eps (const Triangulation<dim> &tria,
std::ostream &out,
const Mapping<dim> *mapping=0) const;
/**
* Write two-dimensional XFig-file.
*
* This function writes all grid cells as
* polygons and optionally boundary
* lines. Several parameters can be
* adjusted by the XFigFlags control
* object.
*
* If levels are coded to depth, the
* complete grid hierarchy is plotted
* with fine cells before their
* parents. This way, levels can be
* switched on and off in xfig by
* selecting levels.
*
* Polygons are either at depth 900-level
* or at 900+@p material_id, depending on
* the flag @p level_depth. Accordingly,
* boundary edges are at depth 800-level
* or at 800+@p boundary_id. Therefore,
* boundary edges are alway in front of
* cells.
*
* Not implemented for the
* codimension one case.
*/
template <int dim>
void write_xfig (const Triangulation<dim> &tria,
std::ostream &out,
const Mapping<dim> *mapping=0) const;
/**
* Write grid to @p out according
* to the given data format. This
* function simply calls the
* appropriate <tt>write_*</tt>
* function.
*/
template <int dim, int spacedim>
void write (const Triangulation<dim,spacedim> &tria,
std::ostream &out,
const OutputFormat output_format,
const Mapping<dim,spacedim> *mapping=0) const;
/**
* Write mesh in default format
* set by ParameterHandler.
*/
template <int dim, int spacedim>
void write (const Triangulation<dim,spacedim> &tria,
std::ostream &out,
const Mapping<dim,spacedim> *mapping=0) const;
/**
* Set flags for DX output
*/
void set_flags (const GridOutFlags::DX &flags);
/**
* Set flags for GMSH output
*/
void set_flags (const GridOutFlags::Msh &flags);
/**
* Set flags for UCD output
*/
void set_flags (const GridOutFlags::Ucd &flags);
/**
* Set flags for GNUPLOT output
*/
void set_flags (const GridOutFlags::Gnuplot &flags);
/**
* Set flags for EPS output of a
* one-dimensional triangulation
*/
void set_flags (const GridOutFlags::Eps<1> &flags);
/**
* Set flags for EPS output of a
* two-dimensional triangulation
*/
void set_flags (const GridOutFlags::Eps<2> &flags);
/**
* Set flags for EPS output of a
* three-dimensional triangulation
*/
void set_flags (const GridOutFlags::Eps<3> &flags);
/**
* Set flags for EPS output of a
* three-dimensional triangulation
*/
void set_flags (const GridOutFlags::XFig &flags);
/**
* Provide a function which tells us which
* suffix with a given output format
* usually has. At present the following
* formats are defined:
* <ul>
* <li> @p OpenDX: <tt>.dx</tt>
* <li> @p gnuplot: <tt>.gnuplot</tt>
* <li> @p ucd: <tt>.inp</tt>
* <li> @p eps: <tt>.eps</tt>.
* </ul>
*
* Since this function does not need data
* from this object, it is static and can
* thus be called without creating an
* object of this class.
*/
static std::string default_suffix (const OutputFormat output_format);
/**
* Default suffix for the default
* output format selected throuw
* ParameterHandler.
*/
std::string default_suffix () const;
/**
* Return the @p OutputFormat value
* corresponding to the given string. If
* the string does not match any known
* format, an exception is thrown.
*
* Since this function does not need data
* from this object, it is static and can
* thus be called without creating an
* object of this class. Its main purpose
* is to allow a program to use any
* implemented output format without the
* need to extend the program's parser
* each time a new format is implemented.
*
* To get a list of presently available
* format names, e.g. to give it to the
* ParameterHandler class, use the
* function <tt>get_output_format_names ()</tt>.
*/
static OutputFormat parse_output_format (const std::string &format_name);
/**
* Return a list of implemented output
* formats. The different names are
* separated by vertical bar signs (<tt>`|'</tt>)
* as used by the ParameterHandler
* classes.
*/
static std::string get_output_format_names ();
/**
* Declare parameters in
* ParameterHandler.
*/
static void declare_parameters (ParameterHandler& param);
/**
* Parse parameters of
* ParameterHandler.
*/
void parse_parameters (ParameterHandler& param);
/**
* Determine an estimate for the
* memory consumption (in bytes)
* of this object.
*/
unsigned int memory_consumption () const;
/**
* Exception
*/
DeclException0 (ExcInvalidState);
private:
/**
* The default output format, set
* by a ParameterHandler.
*/
OutputFormat default_format;
/**
* Flags for OpenDX output.
*/
GridOutFlags::DX dx_flags;
/**
* Flags for GMSH output. Can be
* changed by using the
* @p set_flags function.
*/
GridOutFlags::Msh msh_flags;
/**
* Flags for UCD output. Can be
* changed by using the
* @p set_flags function.
*/
GridOutFlags::Ucd ucd_flags;
/**
* Flags to be used upon output of GNUPLOT
* data. Can be changed by using the
* @p set_flags function.
*/
GridOutFlags::Gnuplot gnuplot_flags;
/**
* Flags to be used upon output of EPS
* data in one space dimension. Can be
* changed by using the @p set_flags
* function.
*/
GridOutFlags::Eps<1> eps_flags_1;
/**
* Flags to be used upon output of EPS
* data in two space dimensions. Can be
* changed by using the @p set_flags
* function.
*/
GridOutFlags::Eps<2> eps_flags_2;
/**
* Flags to be used upon output of EPS
* data in three space dimensions. Can be
* changed by using the @p set_flags
* function.
*/
GridOutFlags::Eps<3> eps_flags_3;
/**
* Flags used for XFig output.
*/
GridOutFlags::XFig xfig_flags;
/**
* Write the grid information about
* faces to @p out. Only those faces
* are printed which are on the boundary
* and which have a boundary indicator
* not equal to zero, since the latter
* is the default for boundary faces.
*
* Since cells and faces are continuously
* numbered, the @p starting_index for
* the numbering of the faces is passed
* also.
*
* This function unfortunately can not
* be included in the regular @p write_msh
* function, since it needs special
* treatment for the case <tt>dim==1</tt>, in
* which case the face iterators are
* <tt>void*</tt>'s and lack the member functions
* which are called. We would not actually
* call these functions, but the compiler
* would complain anyway when compiling
* the function for <tt>dim==1</tt>. Bad luck.
*/
template <int dim, int spacedim>
void write_msh_faces (const Triangulation<dim,spacedim> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 1d. Does
* nothing.
*/
void write_msh_faces (const Triangulation<1,1> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 1d, 2sd. Does
* nothing.
*/
void write_msh_faces (const Triangulation<1,2> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Write the grid information about
* lines to @p out. Only those lines
* are printed which are on the boundary
* and which have a boundary indicator
* not equal to zero, since the latter
* is the default for boundary faces.
*
* Since cells and faces are continuously
* numbered, the @p starting_index for
* the numbering of the lines is passed
* also.
*
* This function unfortunately
* can not be included in the
* regular @p write_msh function,
* since it needs special
* treatment for the case
* <tt>dim==1</tt> and
* <tt>dim==2</tt>, in which case
* the edge iterators are
* <tt>void*</tt>'s and lack the
* member functions which are
* called. We would not actually
* call these functions, but the
* compiler would complain anyway
* when compiling the function
* for <tt>dim==1/2</tt>. Bad luck.
*/
template <int dim, int spacedim>
void write_msh_lines (const Triangulation<dim,spacedim> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 1d. Does
* nothing.
*/
void write_msh_lines (const Triangulation<1,1> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 1d, 2sd. Does
* nothing.
*/
void write_msh_lines (const Triangulation<1,2> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 2d. Does
* nothing.
*/
void write_msh_lines (const Triangulation<2,2> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 2d, 3sd. Does
* nothing.
*/
void write_msh_lines (const Triangulation<2,3> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Write the grid information about
* faces to @p out. Only those faces
* are printed which are on the boundary
* and which have a boundary indicator
* not equal to zero, since the latter
* is the default for boundary faces.
*
* Since cells and faces are continuously
* numbered, the @p starting_index for
* the numbering of the faces is passed
* also.
*
* This function unfortunately can not
* be included in the regular @p write_ucd
* function, since it needs special
* treatment for the case <tt>dim==1</tt>, in
* which case the face iterators are
* <tt>void*</tt>'s and lack the member functions
* which are called. We would not actually
* call these functions, but the compiler
* would complain anyway when compiling
* the function for <tt>dim==1</tt>. Bad luck.
*/
template <int dim, int spacedim>
void write_ucd_faces (const Triangulation<dim,spacedim> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 1d. Does
* nothing.
*/
void write_ucd_faces (const Triangulation<1,1> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 1d, 2sd. Does
* nothing.
*/
void write_ucd_faces (const Triangulation<1,2> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Write the grid information about
* lines to @p out. Only those lines
* are printed which are on the boundary
* and which have a boundary indicator
* not equal to zero, since the latter
* is the default for boundary lines.
*
* Since cells, faces and lines
* are continuously numbered, the
* @p starting_index for the
* numbering of the faces is
* passed also.
*
* This function unfortunately can not
* be included in the regular @p write_ucd
* function, since it needs special
* treatment for the case <tt>dim==1/2</tt>, in
* which case the edge iterators are
* <tt>void*</tt>'s and lack the member functions
* which are called. We would not actually
* call these functions, but the compiler
* would complain anyway when compiling
* the function for <tt>dim==1/2</tt>. Bad luck.
*/
template <int dim, int spacedim>
void write_ucd_lines (const Triangulation<dim,spacedim> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 1d. Does
* nothing.
*/
void write_ucd_lines (const Triangulation<1,1> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 1d, 2sd. Does
* nothing.
*/
void write_ucd_lines (const Triangulation<1,2> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 2d. Does
* nothing.
*/
void write_ucd_lines (const Triangulation<2,2> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Declaration of the specialization
* of above function for 2d, 3sd. Does
* nothing.
*/
void write_ucd_lines (const Triangulation<2,3> &tria,
const unsigned int starting_index,
std::ostream &out) const;
/**
* Return the number of faces in the
* triangulation which have a boundary
* indicator not equal to zero. Only
* these faces are explicitly printed
* in the <tt>write_*</tt> functions;
* all faces with indicator 255 are
* interior ones and an indicator with
* value zero for faces at the boundary
* are considered default.
*
* This function always returns an empty
* list in one dimension.
*
* The reason for this function is the
* same as for @p write_ucd_faces. See
* there for more information.
*/
template <int dim, int spacedim>
unsigned int n_boundary_faces (const Triangulation<dim,spacedim> &tria) const;
/**
* Declaration of the specialization
* of above function for
* 1d. Simply returns zero.
*/
unsigned int n_boundary_faces (const Triangulation<1,1> &tria) const;
/**
* Declaration of the specialization
* of above function for
* 1d, 2sd. Simply returns zero.
*/
unsigned int n_boundary_faces (const Triangulation<1,2> &tria) const;
/**
* Return the number of lines in the
* triangulation which have a boundary
* indicator not equal to zero. Only
* these lines are explicitly printed
* in the <tt>write_*</tt> functions;
* all lines with indicator 255 are
* interior ones and an indicator with
* value zero for faces at the boundary
* are considered default.
*
* This function always returns an empty
* list in one and two dimensions.
*
* The reason for this function is the
* same as for @p write_ucd_faces. See
* there for more information.
*/
template <int dim, int spacedim>
unsigned int n_boundary_lines (const Triangulation<dim,spacedim> &tria) const;
/**
* Declaration of the specialization
* of above function for
* 1d. Simply returns zero.
*/
unsigned int n_boundary_lines (const Triangulation<1,1> &tria) const;
/**
* Declaration of the specialization
* of above function for
* 1d, 2sd. Simply returns zero.
*/
unsigned int n_boundary_lines (const Triangulation<1,2> &tria) const;
/**
* Declaration of the specialization
* of above function for
* 2d. Simply returns zero.
*/
unsigned int n_boundary_lines (const Triangulation<2,2> &tria) const;
/**
* Declaration of the specialization
* of above function for
* 2d, 3sd. Simply returns zero.
*/
unsigned int n_boundary_lines (const Triangulation<2,3> &tria) const;
};
DEAL_II_NAMESPACE_CLOSE
#endif
|