Note: this is documentation for an old release. View the latest documentation at docs.fenicsproject.org/v0.5.1/v0.9.0/cpp
DOLFINx  0.5.1
DOLFINx C++ interface
Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for FidesWriter:
Collaboration graph
[legend]

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)
 Create Fides writer for list of functions. More...
 
 FidesWriter (const FidesWriter &)=delete
 
 FidesWriter (FidesWriter &&file)=default
 Move constructor.
 
 ~FidesWriter ()=default
 Destructor.
 
FidesWriteroperator= (FidesWriter &&)=default
 Move assignment.
 
FidesWriteroperator= (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

- 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.
 
ADIOS2Writeroperator= (ADIOS2Writer &&writer)=default
 Move assignment.
 
ADIOS2Writeroperator= (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.

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]commThe MPI communicator to open the file on
[in]filenameName of output file
[in]meshThe 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 
)

Create Fides writer for list of functions.

Parameters
[in]commThe MPI communicator
[in]filenameName of output file
[in]uList 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

Member Function Documentation

◆ write()

void write ( double  t)

Write data with a given time.

Parameters
[in]tThe time step

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