WarpX
Public Member Functions | Private Attributes | List of all members
FlushFormatOpenPMD Class Reference

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:
FlushFormat

Public Member Functions

 FlushFormatOpenPMD (const std::string &diag_name)
 
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, const std::string prefix, bool plot_raw_fields, bool plot_raw_fields_guards, bool plot_raw_rho, bool plot_raw_F) const override final
 
 ~FlushFormatOpenPMD ()
 
- Public Member Functions inherited from FlushFormat
virtual ~FlushFormat ()
 

Private Attributes

WarpXOpenPMDPlotm_OpenPMDPlotWriter = nullptr
 

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)

Constructor takes name of diagnostics to set the output directory

◆ ~FlushFormatOpenPMD()

FlushFormatOpenPMD::~FlushFormatOpenPMD ( )

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  nlev,
const std::string  prefix,
bool  plot_raw_fields,
bool  plot_raw_fields_guards,
bool  plot_raw_rho,
bool  plot_raw_F 
) const
finaloverridevirtual

Flush fields and particles to plotfile

Implements FlushFormat.

Member Data Documentation

◆ m_OpenPMDPlotWriter

WarpXOpenPMDPlot* FlushFormatOpenPMD::m_OpenPMDPlotWriter = nullptr
private

This is responsible for dumping to file


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