/usr/include/p8est_vtk.h is in libp4est-dev 1.1-4.
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 | /*
This file is part of p4est.
p4est is a C library to manage a collection (a forest) of multiple
connected adaptive quadtrees or octrees in parallel.
Copyright (C) 2010 The University of Texas System
Written by Carsten Burstedde, Lucas C. Wilcox, and Tobin Isaac
p4est 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 2 of the License, or
(at your option) any later version.
p4est 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 p4est; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file p8est_vtk.h
*
* Routines for printing a forest and associated fields to vtk format.
*
* \ingroup p8est
*/
#ifndef P8EST_VTK_H
#define P8EST_VTK_H
#include <p8est_geometry.h>
#include <p8est.h>
SC_EXTERN_C_BEGIN;
/** This writes out the p8est in VTK format.
*
* This is a convenience function for the special
* case of writing out the tree id, quadrant level, and MPI rank only.
* One file is written per MPI rank, and one meta file on rank 0.
* This function will abort if there is a file error.
*
* \param [in] p8est The p8est to be written.
* \param [in] geom A p8est_geometry_t structure or NULL for vertex space.
* \param [in] filename The first part of the file name which will have the
* MPI rank appended to it: The output file will be
* filename_procNum.vtu, and the meta file filename.pvtu.
*/
void p8est_vtk_write_file (p8est_t * p8est,
p8est_geometry_t * geom,
const char *filename);
/** This writes out the p8est and any number of point fields in VTK format.
*
* This is a convenience function that will abort if there is a file error.
*
* \param [in] p8est The p8est to be written.
* \param [in] geom A p8est_geometry_t structure or NULL for vertex space.
* \param [in] scale Double value between 0 and 1 to scale each quadrant.
* \param [in] write_tree Include the tree id as output field.
* \param [in] write_level Include the tree levels as output field.
* \param [in] write_rank Include the MPI rank as output field.
* \param [in] wrap_tree The MPI rank is written module wrap_tree, or 0.
* \param filename First part of the name, see p8est_vtk_write_file.
* \param num_scalars Number of scalar fields to write.
* \param num_vectors Number of vector fields to write.
*
* The variable arguments need to be pairs of (fieldname, fieldvalues)
* where the scalars come first, then the vectors.
*/
void p8est_vtk_write_all (p8est_t * p8est,
p8est_geometry_t * geom,
double scale,
int write_tree, int write_level,
int write_rank, int wrap_rank,
int num_scalars, int num_vectors,
const char *filename, ...);
/** This will write the header of the vtu file.
*
* Writing a VTK file is split into a couple of routines.
* The allows there to be an arbitrary number of
* fields. The calling sequence would be something like
*
* \begincode
* p8est_vtk_write_header(p8est, geom, 1., 1, 1, 1, 0, "output");
* p8est_vtk_write_point_scalar (...);
* ...
* p8est_vtk_write_footer(p8est, "output");
* \endcode
*
* \param p8est The p8est to be written.
* \param geom A p8est_geometry_t structure or NULL for vertex space.
* \param scale The relative length factor of the quadrants.
* Use 1.0 to fit quadrants exactly, less to create gaps.
* \param write_tree Boolean to determine if the tree id should be output.
* \param write_level Boolean to determine if the tree levels should be output.
* \param write_rank Boolean to determine if the MPI rank should be output.
* \param wrap_rank Number to wrap around the rank with a modulo operation.
* Can be 0 for no wrapping.
* \param point_scalars Comma-separated list of point scalar fields, or NULL.
* \param point_vectors Comma-separated list of point vector fields, or NULL.
* \param filename The first part of the name which will have
* the proc number appended to it (i.e., the
* output file will be filename_procNum.vtu).
*
* \return This returns 0 if no error and -1 if there is an error.
*/
int p8est_vtk_write_header (p8est_t * p8est,
p8est_geometry_t * geom,
double scale,
int write_tree, int write_level,
int write_rank, int wrap_rank,
const char *point_scalars,
const char *point_vectors,
const char *filename);
/** This will write a scalar field to the vtu file.
*
* It is good practice to make sure that the scalar field also
* exists in the comma separated string \a point_scalars passed
* to \c p8est_vtk_write_header.
*
* Writing a VTK file is split into a couple of routines.
* The allows there to be an arbitrary number of fields.
*
* \param p8est The p8est to be written.
* \param geom A p8est_geometry_t structure or NULL for vertex space.
* \param filename The first part of the name which will have
* the proc number appended to it (i.e., the
* output file will be filename_procNum.vtu).
* \param scalar_name The name of the scalar field.
* \param values The point values that will be written.
*
* \return This returns 0 if no error and -1 if there is an error.
*/
int p8est_vtk_write_point_scalar (p8est_t * p8est,
p8est_geometry_t * geom,
const char *filename,
const char *scalar_name,
const double *values);
/** This will write a 3-vector field to the vtu file.
*
* It is good practice to make sure that the vector field also
* exists in the comma separated string \a point_vectors passed
* to \c p8est_vtk_write_header.
*
* Writing a VTK file is split into a couple of routines.
* The allows there to be an arbitrary number of fields.
*
* \param p8est The p8est to be written.
* \param geom A p8est_geometry_t structure or NULL for vertex space.
* \param filename The first part of the name which will have
* the proc number appended to it (i.e., the
* output file will be filename_procNum.vtu).
* \param vector_name The name of the vector field.
* \param values The point values that will be written.
*
* \return This returns 0 if no error and -1 if there is an error.
*/
int p8est_vtk_write_point_vector (p8est_t * p8est,
p8est_geometry_t * geom,
const char *filename,
const char *vector_name,
const double *values);
/** This will write the footer of the vtu file.
*
* Writing a VTK file is split into a couple of routines.
* The allows there to be an arbitrary number of
* fields. To write out two fields the
* calling sequence would be something like
*
* \begincode
* p8est_vtk_write_header(p8est, ..., "output");
* p8est_vtk_write_footer(p8est, "output");
* \endcode
*
* \param p8est The p8est to be written.
* \param filename The first part of the name which will have
* the proc number appended to it (i.e., the
* output file will be filename_procNum.vtu).
*
* \return This returns 0 if no error and -1 if there is an error.
*/
int p8est_vtk_write_footer (p8est_t * p8est,
const char *filename);
SC_EXTERN_C_END;
#endif /* !P8EST_VTK_H */
|