This class aims at dumping diags data to disk using the openPMD standard. In particular, function WriteToFile takes fields and particles as input arguments, and writes data to file. More...

#include <FlushFormatOpenPMD.H>

Inheritance diagram for FlushFormatOpenPMD:

Public Member Functions
	FlushFormatOpenPMD (const std::string &diag_name)

void	WriteToFile (const amrex::Vector< std::string > varnames, const amrex::Vector< amrex::MultiFab > &mf, amrex::Vector< amrex::Geometry > &geom, const amrex::Vector< int > iteration, const double time, const amrex::Vector< ParticleDiag > &particle_diags, int, const std::string prefix, int file_min_digits, bool plot_raw_fields, bool plot_raw_fields_guards, bool plot_raw_rho, bool plot_raw_F, bool isBTD=false, int snapshotID=-1, const amrex::Geometry &full_BTD_snapshot=amrex::Geometry(), bool isLastBTDFlush=false) const override

	~FlushFormatOpenPMD () override=default

Public Member Functions inherited from FlushFormat
virtual	~FlushFormat ()

Private Attributes
std::unique_ptr< WarpXOpenPMDPlot >	m_OpenPMDPlotWriter

Detailed Description

This class aims at dumping diags data to disk using the openPMD standard. In particular, function WriteToFile takes fields and particles as input arguments, and writes data to file.

Constructor & Destructor Documentation

◆ FlushFormatOpenPMD()

FlushFormatOpenPMD::FlushFormatOpenPMD ( const std::string & diag_name )

explicit

Constructor takes name of diagnostics to set the output directory

◆ ~FlushFormatOpenPMD()

FlushFormatOpenPMD::~FlushFormatOpenPMD ( )

overridedefault

Member Function Documentation

◆ WriteToFile()

void FlushFormatOpenPMD::WriteToFile	(	const amrex::Vector< std::string >	varnames,
		const amrex::Vector< amrex::MultiFab > &	mf,
		amrex::Vector< amrex::Geometry > &	geom,
		const amrex::Vector< int >	iteration,
		const double	time,
		const amrex::Vector< ParticleDiag > &	particle_diags,
		int	,
		const std::string	prefix,
		int	file_min_digits,
		bool	plot_raw_fields,
		bool	plot_raw_fields_guards,
		bool	plot_raw_rho,
		bool	plot_raw_F,
		bool	isBTD = `false`,
		int	snapshotID = `-1`,
		const amrex::Geometry &	full_BTD_snapshot = `amrex::Geometry()`,
		bool	isLastBTDFlush = `false`
	)		const

overridevirtual

Flush fields and particles to plotfile

Implements FlushFormat.

Member Data Documentation

◆ m_OpenPMDPlotWriter

std::unique_ptr< WarpXOpenPMDPlot > FlushFormatOpenPMD::m_OpenPMDPlotWriter

private

This is responsible for dumping to file

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

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/21.10/Source/Diagnostics/FlushFormats/FlushFormatOpenPMD.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/21.10/Source/Diagnostics/FlushFormats/FlushFormatOpenPMD.cpp

Public Member Functions

Private Attributes