FidesWriter Class Reference

Output of meshes and functions compatible with the Fides Paraview reader, see https://fides.readthedocs.io/en/latest/paraview/paraview.html. More...

#include <ADIOS2Writers.h>

Inheritance diagram for FidesWriter:

Collaboration diagram for FidesWriter:

Public Types
enum class	MeshPolicy { update , reuse }
	Mesh reuse policy. More...

Public Member Functions
	FidesWriter (MPI_Comm comm, const std::filesystem::path &filename, std::shared_ptr< const mesh::Mesh > mesh)
	Create Fides writer for a mesh. More...
	FidesWriter (MPI_Comm comm, const std::filesystem::path &filename, const ADIOS2Writer::U &u, const MeshPolicy mesh_policy=MeshPolicy::update)
	Create Fides writer for list of functions. More...
	FidesWriter (const FidesWriter &)=delete
	FidesWriter (FidesWriter &&file)=default
	Move constructor.
	~FidesWriter ()=default
	Destructor.
FidesWriter &	operator= (FidesWriter &&)=default
	Move assignment.
FidesWriter &	operator= (const FidesWriter &)=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
Protected Member Functions inherited from ADIOS2Writer
	ADIOS2Writer (MPI_Comm comm, const std::filesystem::path &filename, 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, 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

Output of meshes and functions compatible with the Fides Paraview reader, see https://fides.readthedocs.io/en/latest/paraview/paraview.html.

Member Enumeration Documentation

MeshPolicy

enum class MeshPolicy

strong

Mesh reuse policy.

Enumerator
update	Re-write the mesh to file upon every write of a fem::Function.
reuse	Write the mesh to file only the first time a fem::Function is written to file.

Constructor & Destructor Documentation

FidesWriter() [1/2]

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

Create Fides writer for a mesh.

Parameters

[in]	comm	The MPI communicator to open the file on
[in]	filename	Name of output file
[in]	mesh	The mesh. The mesh must a degree 1 mesh.

Note

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

FidesWriter() [2/2]

FidesWriter	(	MPI_Comm	comm,
		const std::filesystem::path &	filename,
		const ADIOS2Writer::U &	u,
		const MeshPolicy	mesh_policy = MeshPolicy::update
	)

Create Fides writer for list of functions.

Parameters

[in]	comm	The MPI communicator
[in]	filename	Name of output file
[in]	u	List of functions. The functions must (1) share the same mesh (degree 1) and (2) be degree 1 Lagrange.

Note

All functions in u must share the same Mesh

Parameters

[in]

mesh_policy

Controls if the mesh is written to file at the first time step only or is re-written (updated) at each time step.

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