VTXWriter Class Reference

Writer for meshes and functions using the ADIOS2 VTX format, see https://adios2.readthedocs.io/en/latest/ecosystem/visualization.html#using-vtk-and-paraview. More...

#include <ADIOS2Writers.h>

Inheritance diagram for VTXWriter:

Collaboration diagram for VTXWriter:

Public Member Functions
	VTXWriter (MPI_Comm comm, const std::filesystem::path &filename, std::shared_ptr< const mesh::Mesh > mesh)
	Create a VTX writer for a mesh. This format supports arbitrary degree meshes. More...
	VTXWriter (MPI_Comm comm, const std::filesystem::path &filename, const U &u)
	Create a VTX writer for list of functions. More...
	VTXWriter (const VTXWriter &)=delete
	VTXWriter (VTXWriter &&file)=default
	Move constructor.
	~VTXWriter ()=default
	Destructor.
VTXWriter &	operator= (VTXWriter &&)=default
	Move assignment.
VTXWriter &	operator= (const VTXWriter &)=delete
void	write (double t)
	Write data with a given time. More...
Public Member Functions inherited from ADIOS2Writer
void	close ()
	Close the file.

Additional Inherited Members
Public Types inherited from ADIOS2Writer
using	Fdr = fem::Function< double >
	Typedefs.
using	Fdc = fem::Function< std::complex< double > >
	Typedefs.
using	U = std::vector< std::variant< std::shared_ptr< const Fdr >, std::shared_ptr< const Fdc > >>
	Typedefs.
Protected Member Functions inherited from ADIOS2Writer
	ADIOS2Writer (MPI_Comm comm, const std::filesystem::path &filename, const std::string &tag, std::shared_ptr< const mesh::Mesh > mesh)
	Create an ADIOS2-based writer for a mesh. More...
	ADIOS2Writer (MPI_Comm comm, const std::filesystem::path &filename, const std::string &tag, const U &u)
	Create an ADIOS2-based writer for a list of functions. More...
	ADIOS2Writer (ADIOS2Writer &&writer)=default
	Move constructor.
	ADIOS2Writer (const ADIOS2Writer &)=delete
	Copy constructor.
	~ADIOS2Writer ()
	Destructor.
ADIOS2Writer &	operator= (ADIOS2Writer &&writer)=default
	Move assignment.
ADIOS2Writer &	operator= (const ADIOS2Writer &)=delete

Detailed Description

Writer for meshes and functions using the ADIOS2 VTX format, see https://adios2.readthedocs.io/en/latest/ecosystem/visualization.html#using-vtk-and-paraview.

The output files can be visualized using ParaView.

Constructor & Destructor Documentation

VTXWriter() [1/2]

VTXWriter	(	MPI_Comm	comm,
		const std::filesystem::path &	filename,
		std::shared_ptr< const mesh::Mesh >	mesh
	)

Create a VTX writer for a mesh. This format supports arbitrary degree meshes.

Parameters

[in]	comm	The MPI communicator to open the file on
[in]	filename	Name of output file
[in]	mesh	The mesh to write

Note

This format support arbitrary degree meshes

The mesh geometry can be updated between write steps but the topology should not be changed between write steps

VTXWriter() [2/2]

VTXWriter	(	MPI_Comm	comm,
		const std::filesystem::path &	filename,
		const U &	u
	)

Create a VTX writer for list of functions.

Parameters

[in]	comm	The MPI communicator to open the file on
[in]	filename	Name of output file
[in]	u	List of functions. The functions must (1) share the same mesh and (2) be (discontinuous) Lagrange functions. The element family and degree must be the same for all functions.

Note

This format supports arbitrary degree meshes

Member Function Documentation

write()

void write

(

double

t

)

Write data with a given time.

Parameters

[in]

t

The time step

---

The documentation for this class was generated from the following files:

• /__w/dolfinx/dolfinx/cpp/dolfinx/io/ADIOS2Writers.h
• /__w/dolfinx/dolfinx/cpp/dolfinx/io/ADIOS2Writers.cpp