BTDParticleDataHeaderImpl Class Reference

Class to read, modify, and write particle header file, Particle_H, when back-transformed diag format is selected as plotfile. This class enables multiple particle buffers to be interweaved and stitched into a single plotfile with a single Particle_H file. More...

#include <BTD_Plotfile_Header_Impl.H>

Public Member Functions
	BTDParticleDataHeaderImpl (std::string const &Headerfile_path)
void	ReadHeader ()
void	WriteHeader () const
int	ba_size () const
void	IncreaseBoxArraySize (const int add_size)
amrex::Box	ba_box (int ibox) const
void	ResizeBoxArray ()
void	SetBox (int ibox, amrex::Box ba_box)

Public Attributes
int	m_ba_size
amrex::BoxArray	m_ba
std::string	m_Header_path

Detailed Description

Class to read, modify, and write particle header file, Particle_H, when back-transformed diag format is selected as plotfile. This class enables multiple particle buffers to be interweaved and stitched into a single plotfile with a single Particle_H file.

Constructor & Destructor Documentation

BTDParticleDataHeaderImpl()

BTDParticleDataHeaderImpl::BTDParticleDataHeaderImpl

(

std::string const &

Headerfile_path

)

Constructor.

Parameters

[in]

Headerfile_path

containing path of Headerfile

Member Function Documentation

ba_box()

amrex::Box BTDParticleDataHeaderImpl::ba_box ( int ibox ) const

inlinenodiscard

Returns box corresponding to the ith box in the BoxArray, m_ba.

Parameters

[in]

ibox

index of the box in the BoxArray.

ba_size()

int BTDParticleDataHeaderImpl::ba_size ( ) const

inlinenodiscard

Returns the size of the box array, m_ba_size

IncreaseBoxArraySize()

void BTDParticleDataHeaderImpl::IncreaseBoxArraySize ( const int add_size )

inline

Increases Box array size, m_ba_size, by add_size

Parameters

[in]

add_size

ReadHeader()

void BTDParticleDataHeaderImpl::ReadHeader

(

)

Reads the particle header file at m_Header_path and stores its data

ResizeBoxArray()

void BTDParticleDataHeaderImpl::ResizeBoxArray ( )

inline

Resize boxArray, m_ba, to size, m_ba_size.

SetBox()

void BTDParticleDataHeaderImpl::SetBox ( int ibox, amrex::Box ba_box )

inline

Set Box indices of the ith-box in Box Array, m_ba, to the new Box, ba_box.

Parameters

[in]	ibox	index of the ith box in BoxArray, m_ba.
[in]	ba_box	dimensions corresponding to the ith Fab.

WriteHeader()

void BTDParticleDataHeaderImpl::WriteHeader

(

)

const

Writes the meta-data of particle box array in header file, with path, m_Header_path

Member Data Documentation

m_ba

amrex::BoxArray BTDParticleDataHeaderImpl::m_ba

BoxArray for particle output

m_ba_size

int BTDParticleDataHeaderImpl::m_ba_size

Size of BoxArray, m_ba

m_Header_path

std::string BTDParticleDataHeaderImpl::m_Header_path

string containing path of the particle output of species, species_name.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Diagnostics/BTD_Plotfile_Header_Impl.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Diagnostics/BTD_Plotfile_Header_Impl.cpp