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

#include <FlushFormatPlotfile.H>

Inheritance diagram for FlushFormatPlotfile:

Public Member Functions
virtual 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 nlev, const std::string prefix, int file_min_digits, bool plot_raw_fields, bool plot_raw_fields_guards, const bool use_pinned_pc=false, bool isBTD=false, int snapshotID=-1, int bufferID=1, int numBuffers=1, const amrex::Geometry &full_BTD_snapshot=amrex::Geometry(), bool isLastBTDFlush=false, const amrex::Vector< int > &totalParticlesFlushedAlready=amrex::Vector< int >()) const override

void	WriteJobInfo (const std::string &dir) const

void	WriteWarpXHeader (const std::string &name, amrex::Vector< amrex::Geometry > &geom) const

void	WriteAllRawFields (const bool plot_raw_fields, const int nlevels, const std::string &plotfilename, const bool plot_raw_fields_guards) const

void	WriteParticles (const std::string &filename, const amrex::Vector< ParticleDiag > &particle_diags, const amrex::Real time, bool isBTD=false) const
	Write particles data to file. More...

	~FlushFormatPlotfile ()

Public Member Functions inherited from FlushFormat
virtual	~FlushFormat ()

Detailed Description

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

Constructor & Destructor Documentation

◆ ~FlushFormatPlotfile()

FlushFormatPlotfile::~FlushFormatPlotfile ( )

inline

Member Function Documentation

◆ WriteAllRawFields()

void FlushFormatPlotfile::WriteAllRawFields	(	const bool	plot_raw_fields,
		const int	nlevels,
		const std::string &	plotfilename,
		const bool	plot_raw_fields_guards
	)		const

◆ WriteJobInfo()

void FlushFormatPlotfile::WriteJobInfo ( const std::string & dir ) const

Write general info of the run into the plotfile

◆ WriteParticles()

void FlushFormatPlotfile::WriteParticles	(	const std::string &	filename,
		const amrex::Vector< ParticleDiag > &	particle_diags,
		const amrex::Real	time,
		bool	isBTD = `false`
	)		const

Write particles data to file.

Parameters

[in]	filename	name of output directory
[in]	particle_diags	Each element of this vector handles output of 1 species.
[in]	time	the simulation time on the coarsest level
[in]	isBTD	whether this is a back-transformed diagnostic

◆ WriteToFile()

void FlushFormatPlotfile::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	nlev,
		const std::string	prefix,
		int	file_min_digits,
		bool	plot_raw_fields,
		bool	plot_raw_fields_guards,
		const bool	use_pinned_pc = `false`,
		bool	isBTD = `false`,
		int	snapshotID = `-1`,
		int	bufferID = `1`,
		int	numBuffers = `1`,
		const amrex::Geometry &	full_BTD_snapshot = `amrex::Geometry()`,
		bool	isLastBTDFlush = `false`,
		const amrex::Vector< int > &	totalParticlesFlushedAlready = `amrex::Vector<int>()`
	)		const

overridevirtual

Flush fields and particles to plotfile

Implements FlushFormat.

Reimplemented in FlushFormatCheckpoint.

◆ WriteWarpXHeader()

void FlushFormatPlotfile::WriteWarpXHeader	(	const std::string &	name,
		amrex::Vector< amrex::Geometry > &	geom
	)		const

Write WarpX-specific plotfile header

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

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/23.08/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/23.08/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.cpp

Public Member Functions