XDMFFile.h¶

Note

The documentation on this page was automatically extracted from the DOLFIN C++ code and may need to be edited or expanded.

class XDMFFile¶

Parent class(es)

Variable

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.

enum class Encoding: File encoding type

XDMFFile(const std::string filename)¶: Constructor

XDMFFile(MPI_Comm comm, const std::string filename)¶: Constructor

void write(const Mesh &mesh, Encoding encoding = Encoding::HDF5)¶

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 Function &u, 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, double t, 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 MeshFunction<bool> &meshfunction, 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 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<bool>_): 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<int>_): A list of points to save.
encoding (_Encoding_): Encoding to use: HDF5 or ASCII

void write(const MeshValueCollection<double> &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 std::vector<Point> &points, 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, const std::vector<double> &values, 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 read(Mesh &mesh) const¶

Read in a mesh

Arguments: mesh (Mesh)

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 first MeshFunction from file @param meshfunction @param name

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 = "")¶: Read MeshValueCollection from file