WarpX
Public Member Functions | List of all members
FlushFormatPlotfile Class Reference

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

Public Member Functions

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 nlev, 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
 
void WriteJobInfo (const std::string &dir) const
 
void WriteWarpXHeader (const std::string &name, amrex::Vector< amrex::Geometry > &geom) const
 
void WriteAllRawFields (bool plot_raw_fields, int nlevels, const std::string &plotfilename, bool plot_raw_fields_guards) const
 
void WriteParticles (const std::string &dir, const amrex::Vector< ParticleDiag > &particle_diags, amrex::Real time, bool isBTD=false) const
 Write particles data to file. More...
 
 FlushFormatPlotfile ()=default
 
 ~FlushFormatPlotfile () override=default
 
 FlushFormatPlotfile (FlushFormatPlotfile const &)=default
 
FlushFormatPlotfileoperator= (FlushFormatPlotfile const &)=default
 
 FlushFormatPlotfile (FlushFormatPlotfile &&)=default
 
FlushFormatPlotfileoperator= (FlushFormatPlotfile &&)=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
 

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() [1/3]

FlushFormatPlotfile::FlushFormatPlotfile ( )
default

◆ ~FlushFormatPlotfile()

FlushFormatPlotfile::~FlushFormatPlotfile ( )
overridedefault

◆ FlushFormatPlotfile() [2/3]

FlushFormatPlotfile::FlushFormatPlotfile ( FlushFormatPlotfile const &  )
default

◆ FlushFormatPlotfile() [3/3]

FlushFormatPlotfile::FlushFormatPlotfile ( FlushFormatPlotfile &&  )
default

Member Function Documentation

◆ operator=() [1/2]

FlushFormatPlotfile& FlushFormatPlotfile::operator= ( FlushFormatPlotfile &&  )
default

◆ operator=() [2/2]

FlushFormatPlotfile& FlushFormatPlotfile::operator= ( FlushFormatPlotfile const &  )
default

◆ WriteAllRawFields()

void FlushFormatPlotfile::WriteAllRawFields ( bool  plot_raw_fields,
int  nlevels,
const std::string &  plotfilename,
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 &  dir,
const amrex::Vector< ParticleDiag > &  particle_diags,
amrex::Real  time,
bool  isBTD = false 
) const

Write particles data to file.

Parameters
[in]dirname of output directory
[in]particle_diagsEach element of this vector handles output of 1 species.
[in]timethe simulation time on the coarsest level
[in]isBTDwhether 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,
amrex::Vector< int iteration,
double  time,
const amrex::Vector< ParticleDiag > &  particle_diags,
int  nlev,
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.

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