/usr/include/dolfin/io/XDMFFile.h is in libdolfin-dev 2016.2.0-2.
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 | // Copyright (C) 2012-2015 Chris N. Richardson and Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// DOLFIN 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Garth N. Wells, 2012
#ifndef __DOLFIN_XDMFFILE_H
#define __DOLFIN_XDMFFILE_H
#include <cstdint>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#ifdef HAS_HDF5
#include <hdf5.h>
#else
typedef int hid_t;
#endif
#include <dolfin/common/MPI.h>
#include <dolfin/common/Variable.h>
namespace boost
{
namespace filesystem
{
class path;
}
}
namespace pugi
{
class xml_node;
class xml_document;
}
namespace dolfin
{
// Forward declarations
class Function;
#ifdef HAS_HDF5
class HDF5File;
#endif
class LocalMeshData;
class Mesh;
template<typename T> class MeshFunction;
template<typename T> class MeshValueCollection;
class Point;
class XDMFxml;
/// This class supports the output of meshes and functions in XDMF
/// (http://www.xdmf.org) format. It creates an XML file that
/// describes the data and points to a HDF5 file that stores the
/// actual problem data. Output of data in parallel is supported.
///
/// XDMF is not suitable for checkpointing as it may decimate some
/// data.
class XDMFFile : public Variable
{
public:
/// File encoding type
enum class Encoding {HDF5, ASCII};
/// Constructor
XDMFFile(const std::string filename)
: XDMFFile(MPI_COMM_WORLD, filename) {}
/// Constructor
XDMFFile(MPI_Comm comm, const std::string filename);
/// Destructor
~XDMFFile();
/// Save a mesh to XDMF format, either using an associated HDF5
/// file, or storing the data inline as XML Create function on
/// given function space
///
/// *Arguments*
/// mesh (_Mesh_)
/// A mesh to save.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const Mesh& mesh, Encoding encoding=Encoding::HDF5);
/// Save a Function to XDMF file for visualisation, using an
/// associated HDF5 file, or storing the data inline as XML.
///
/// *Arguments*
/// u (_Function_)
/// A function to save.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const Function& u, Encoding encoding=Encoding::HDF5);
/// Save a Function with timestamp to XDMF file for visualisation,
/// using an associated HDF5 file, or storing the data inline as
/// XML.
///
/// *Arguments*
/// u (_Function_)
/// A function to save.
/// t (_double_)
/// Timestep
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const Function& u, double t, Encoding encoding=Encoding::HDF5);
/// Save MeshFunction to file using an associated HDF5 file, or
/// storing the data inline as XML.
///
/// *Arguments*
/// meshfunction (_MeshFunction_)
/// A meshfunction to save.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const MeshFunction<bool>& meshfunction,
Encoding encoding=Encoding::HDF5);
void write(const MeshFunction<int>& meshfunction,
Encoding encoding=Encoding::HDF5);
void write(const MeshFunction<std::size_t>& meshfunction,
Encoding encoding=Encoding::HDF5);
void write(const MeshFunction<double>& meshfunction,
Encoding encoding=Encoding::HDF5);
/// Write out mesh value collection (subset) using an associated
/// HDF5 file, or storing the data inline as XML.
///
/// *Arguments*
/// mvc (_MeshValueCollection<bool>_)
/// A list of points to save.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const MeshValueCollection<bool>& mvc,
Encoding encoding=Encoding::HDF5);
/// Write out mesh value collection (subset) using an associated
/// HDF5 file, or storing the data inline as XML.
///
/// *Arguments*
/// mvc (_MeshValueCollection<int>_)
/// A list of points to save.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const MeshValueCollection<int>& mvc,
Encoding encoding=Encoding::HDF5);
/// Write out mesh value collection (subset) using an associated
/// HDF5 file, or storing the data inline as XML.
///
/// *Arguments*
/// mvc (_MeshValueCollection<int>_)
/// A list of points to save.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const MeshValueCollection<std::size_t>& mvc,
Encoding encoding=Encoding::HDF5);
/// Write out mesh value collection (subset) using an associated
/// HDF5 file, or storing the data inline as XML.
///
/// *Arguments*
/// mvc (_MeshValueCollection<double>_)
/// A list of points to save.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const MeshValueCollection<double>& mvc,
Encoding encoding=Encoding::HDF5);
/// Save a cloud of points to file using an associated HDF5 file,
/// or storing the data inline as XML.
///
/// *Arguments*
/// points (_std::vector<Point>_)
/// A list of points to save.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const std::vector<Point>& points,
Encoding encoding=Encoding::HDF5);
/// Save a cloud of points, with scalar values using an associated
/// HDF5 file, or storing the data inline as XML.
///
/// *Arguments*
/// points (_std::vector<Point>_)
/// A list of points to save.
/// values (_std::vector<double>_)
/// A list of values at each point.
/// encoding (_Encoding_)
/// Encoding to use: HDF5 or ASCII
///
void write(const std::vector<Point>& points,
const std::vector<double>& values,
Encoding encoding=Encoding::HDF5);
/// Read in a mesh
///
/// *Arguments*
/// mesh (_Mesh_)
///
void read(Mesh& mesh) const;
/// Read first MeshFunction from file
/// @param meshfunction
/// @param name
void read(MeshFunction<bool>& meshfunction, std::string name="");
/// Read first MeshFunction from file
/// @param meshfunction
/// @param name
void read(MeshFunction<int>& meshfunction, std::string name="");
/// Read first MeshFunction from file
/// @param meshfunction
/// @param name
void read(MeshFunction<std::size_t>& meshfunction, std::string name="");
/// Read first MeshFunction from file
/// @param meshfunction
/// @param name
void read(MeshFunction<double>& meshfunction, std::string name="");
/// Read MeshValueCollection from file
void read(MeshValueCollection<bool>& mvc, std::string name="");
/// Read MeshValueCollection from file
void read(MeshValueCollection<int>& mvc, std::string name="");
/// Read MeshValueCollection from file
void read(MeshValueCollection<std::size_t>& mvc, std::string name="");
/// Read MeshValueCollection from file
void read(MeshValueCollection<double>& mvc, std::string name="");
private:
// Generic MVC writer
template <typename T>
void write_mesh_value_collection(const MeshValueCollection<T>& mvc,
Encoding encoding);
// Generic MVC reader
template <typename T>
void read_mesh_value_collection(MeshValueCollection<T>& mvc,
std::string name);
// Remap meshfunction data, scattering data to appropriate processes
template <typename T>
static void remap_meshfunction_data(MeshFunction<T>& meshfunction,
const std::vector<std::int64_t>& topology_data,
const std::vector<T>& value_data);
// Build mesh (serial)
static void build_mesh(Mesh& mesh, const CellType& cell_type,
std::int64_t num_points, std::int64_t num_cells,
int tdim, int gdim,
const pugi::xml_node& topology_dataset_node,
const pugi::xml_node& geometry_dataset_node,
const boost::filesystem::path& parent_path);
// Build local mesh data structure
static void
build_local_mesh_data (LocalMeshData& local_mesh_data,
const CellType& cell_type,
std::int64_t num_points, std::int64_t num_cells,
int tdim, int gdim,
const pugi::xml_node& topology_dataset_node,
const pugi::xml_node& geometry_dataset_node,
const boost::filesystem::path& parent_path);
static void build_mesh_quadratic(Mesh& mesh, const CellType& cell_type,
std::int64_t num_points, std::int64_t num_cells,
int tdim, int gdim,
const pugi::xml_node& topology_dataset_node,
const pugi::xml_node& geometry_dataset_node,
const boost::filesystem::path& relative_path);
// Add mesh to XDMF xml_node (usually a Domain or Time Grid) and write data
static void add_mesh(MPI_Comm comm, pugi::xml_node& xml_node,
hid_t h5_id, const Mesh& mesh,
const std::string path_prefix);
// Add set of points to XDMF xml_node and write data
static void add_points(MPI_Comm comm, pugi::xml_node& xml_node,
hid_t h5_id, const std::vector<Point>& points);
// Add topology node to xml_node (includes writing data to XML or HDF5
// file)
template<typename T>
static void add_topology_data(MPI_Comm comm, pugi::xml_node& xml_node,
hid_t h5_id, const std::string path_prefix,
const Mesh& mesh, int tdim);
// Add geometry node and data to xml_node
static void add_geometry_data(MPI_Comm comm, pugi::xml_node& xml_node,
hid_t h5_id, const std::string path_prefix,
const Mesh& mesh);
// Add DataItem node to an XML node. If HDF5 is open (h5_id > 0) the data is
// written to the HDFF5 file with the path 'h5_path'. Otherwise, data is
// witten to the XML node and 'h5_path' is ignored
template<typename T>
static void add_data_item(MPI_Comm comm, pugi::xml_node& xml_node,
hid_t h5_id, const std::string h5_path, const T& x,
const std::vector<std::int64_t> dimensions,
const std::string number_type="");
// Calculate set of entities of dimension cell_dim which are duplicated
// on other processes and should not be output on this process
static std::set<unsigned int> compute_nonlocal_entities(const Mesh& mesh,
int cell_dim);
// Return topology data on this process as a flat vector
template<typename T>
static std::vector<T> compute_topology_data(const Mesh& mesh, int cell_dim);
// Return quadratic topology for Mesh of degree 2
template<typename T>
static std::vector<T> compute_quadratic_topology(const Mesh& mesh);
// Return data which is local
template<typename T>
std::vector<T> compute_value_data(const MeshFunction<T>& meshfunction);
// Get DOLFIN cell type string from XML topology node
static std::pair<std::string, int>
get_cell_type(const pugi::xml_node& topology_node);
// Get dimensions from an XML DataSet node
static std::vector<std::int64_t>
get_dataset_shape(const pugi::xml_node& dataset_node);
// Get number of cells from an XML Topology node
static std::int64_t get_num_cells(const pugi::xml_node& topology_node);
// Return data associated with a data set node
template <typename T>
static std::vector<T> get_dataset(MPI_Comm comm,
const pugi::xml_node& dataset_node,
const boost::filesystem::path& parent_path);
// Return (0) HDF5 filename and (1) path in HDF5 file from a DataItem node
static std::array<std::string, 2> get_hdf5_paths(const pugi::xml_node& dataitem_node);
static std::string get_hdf5_filename(std::string xdmf_filename);
// Generic MeshFunction reader
template<typename T>
void read_mesh_function(MeshFunction<T>& meshfunction, std::string name="");
// Generic MeshFunction writer
template<typename T>
void write_mesh_function(const MeshFunction<T>& meshfunction,
Encoding encoding);
// Get data width - normally the same as u.value_size(), but expand for 2D
// vector/tensor because XDMF presents everything as 3D
static std::int64_t get_padded_width(const Function& u);
// Returns true for DG0 Functions
static bool has_cell_centred_data(const Function& u);
// Get point data values for linear or quadratic mesh into
// flattened 2D array
static std::vector<double> get_point_data_values(const Function& u);
// Get point data values collocated at P2 geometry points (vertices
// and edges) flattened as a 2D array
static std::vector<double> get_p2_data_values(const Function& u);
// Get cell data values as a flattened 2D array
static std::vector<double> get_cell_data_values(const Function& u);
// Check whether the requested encoding is supported
void check_encoding(Encoding encoding) const;
// Generate the XDMF format string based on the Encoding
// enumeration
static std::string xdmf_format_str(Encoding encoding)
{ return (encoding == XDMFFile::Encoding::HDF5) ? "HDF" : "XML"; }
static std::string vtk_cell_type_str(CellType::Type cell_type, int order);
// Return a string of the form "x y"
template <typename X, typename Y>
static std::string to_string(X x, Y y);
// Return a vector of numerical values from a vector of stringstream
template <typename T>
static std::vector<T> string_to_vector(const std::vector<std::string>& x_str);
// Convert a value_rank to the XDMF string description (Scalar, Vector, Tensor)
static std::string rank_to_string(std::size_t value_rank);
// MPI communicator
MPI_Comm _mpi_comm;
// HDF5 data file
#ifdef HAS_HDF5
std::unique_ptr<HDF5File> _hdf5_file;
#endif
// Cached filename
const std::string _filename;
// Counter for time series
std::size_t _counter;
// The XML document currently representing the XDMF
// which needs to be kept open for time series etc.
std::unique_ptr<pugi::xml_document> _xml_doc;
};
// Specialisation for std::vector<bool>, as HDF5 does not support it natively
template<> inline
void XDMFFile::add_data_item(MPI_Comm comm, pugi::xml_node& xml_node,
hid_t h5_id, const std::string h5_path,
const std::vector<bool>& x,
const std::vector<std::int64_t> shape,
const std::string number_type)
{
// HDF5 cannot accept 'bool' so copy to 'int'
std::vector<int> x_int(x.size());
for (std::size_t i = 0; i < x.size(); ++i)
x_int[i] = (int)x[i];
add_data_item(comm, xml_node, h5_id, h5_path, x_int, shape, number_type);
}
}
#endif
|