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

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)
 
void WriteToFile (const amrex::Vector< std::string > &varnames, const amrex::Vector< amrex::MultiFab > &mf, amrex::Vector< amrex::Geometry > &geom, amrex::Vector< int > iteration, double time, const amrex::Vector< ParticleDiag > &particle_diags, int output_levels, std::string prefix, int file_min_digits, bool plot_raw_fields, bool plot_raw_fields_guards, 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 override
 
 ~FlushFormatOpenPMD () override=default
 
 FlushFormatOpenPMD (FlushFormatOpenPMD const &)=delete
 
FlushFormatOpenPMDoperator= (FlushFormatOpenPMD const &)=delete
 
 FlushFormatOpenPMD (FlushFormatOpenPMD &&)=default
 
FlushFormatOpenPMDoperator= (FlushFormatOpenPMD &&)=default
 
- Public Member Functions inherited from FlushFormat
 FlushFormat ()=default
 
virtual ~FlushFormat ()=default
 
 FlushFormat (FlushFormat const &)=default
 
FlushFormatoperator= (FlushFormat const &)=default
 
 FlushFormat (FlushFormat &&)=default
 
FlushFormatoperator= (FlushFormat &&)=default
 

Private Attributes

std::unique_ptr< WarpXOpenPMDPlotm_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() [1/3]

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

Constructor takes name of diagnostics to set the output directory

◆ ~FlushFormatOpenPMD()

FlushFormatOpenPMD::~FlushFormatOpenPMD ( )
overridedefault

◆ FlushFormatOpenPMD() [2/3]

FlushFormatOpenPMD::FlushFormatOpenPMD ( FlushFormatOpenPMD const &  )
delete

◆ FlushFormatOpenPMD() [3/3]

FlushFormatOpenPMD::FlushFormatOpenPMD ( FlushFormatOpenPMD &&  )
default

Member Function Documentation

◆ operator=() [1/2]

FlushFormatOpenPMD& FlushFormatOpenPMD::operator= ( FlushFormatOpenPMD &&  )
default

◆ operator=() [2/2]

FlushFormatOpenPMD& FlushFormatOpenPMD::operator= ( FlushFormatOpenPMD const &  )
delete

◆ WriteToFile()

void FlushFormatOpenPMD::WriteToFile ( const amrex::Vector< std::string > &  varnames,
const amrex::Vector< amrex::MultiFab > &  mf,
amrex::Vector< amrex::Geometry > &  geom,
amrex::Vector< int iteration,
double  time,
const amrex::Vector< ParticleDiag > &  particle_diags,
int  output_levels,
std::string  prefix,
int  file_min_digits,
bool  plot_raw_fields,
bool  plot_raw_fields_guards,
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
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: