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>
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.
◆ BTDParticleDataHeaderImpl()
BTDParticleDataHeaderImpl::BTDParticleDataHeaderImpl |
( |
std::string const & |
Headerfile_path | ) |
|
Constructor.
- Parameters
-
[in] | Headerfile_path | containing path of Headerfile |
◆ ba_box()
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 |
|
inline |
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
-
◆ 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
◆ m_ba
BoxArray for particle output
◆ m_ba_size
int BTDParticleDataHeaderImpl::m_ba_size |
◆ 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: