Class to read, modify, and write species header when back-transformed diag format is selected as plotfile. This class enables multiple BTD particle buffers to be interweaved and stitched into a single plotfile with a single Header.
More...
#include <BTD_Plotfile_Header_Impl.H>
Class to read, modify, and write species header when back-transformed diag format is selected as plotfile. This class enables multiple BTD particle buffers to be interweaved and stitched into a single plotfile with a single Header.
◆ BTDSpeciesHeaderImpl()
BTDSpeciesHeaderImpl::BTDSpeciesHeaderImpl |
( |
std::string const & |
Headerfile_path, |
|
|
std::string const & |
species_name |
|
) |
| |
Constructor.
- Parameters
-
[in] | Headerfile_path | string containing path of Headerfile |
[in] | species_name | string containing species name |
◆ AddTotalParticles()
void BTDSpeciesHeaderImpl::AddTotalParticles |
( |
const int |
new_particles | ) |
|
|
inline |
Add new_particles to existing to obtain the total number of particles of the species.
- Parameters
-
[in] | new_particles | total particles in the new buffer |
◆ AppendParticleInfoForNewBox()
void BTDSpeciesHeaderImpl::AppendParticleInfoForNewBox |
( |
int |
data_index, |
|
|
int |
particles_per_box, |
|
|
int |
offset |
|
) |
| |
Append particle info of the newly added box, namely, m_which_data, m_particles_per_box, m_offset_per_box.
◆ IncrementParticleBoxArraySize()
void BTDSpeciesHeaderImpl::IncrementParticleBoxArraySize |
( |
| ) |
|
|
inline |
Increment number of boxes in a box array by 1, with every flush.
◆ ReadHeader()
void BTDSpeciesHeaderImpl::ReadHeader |
( |
| ) |
|
Reads the Header file for BTD species
◆ set_DataIndex()
void BTDSpeciesHeaderImpl::set_DataIndex |
( |
int |
lev, |
|
|
int |
box_id, |
|
|
int |
data_index |
|
) |
| |
Set data Index of the data-file, DATAXXXXX, that the particles belong to
◆ WriteHeader()
void BTDSpeciesHeaderImpl::WriteHeader |
( |
| ) |
|
Writes the meta-data of species Header file, with path, m_Header_path
◆ m_file_version
std::string BTDSpeciesHeaderImpl::m_file_version |
|
private |
String containing file version of the species output
◆ m_finestLevel
int BTDSpeciesHeaderImpl::m_finestLevel |
finest level of the particle output
◆ m_Header_path
std::string BTDSpeciesHeaderImpl::m_Header_path |
|
private |
◆ m_int_comp_names
amrex::Vector<std::string> BTDSpeciesHeaderImpl::m_int_comp_names |
|
private |
◆ m_is_checkpoint
bool BTDSpeciesHeaderImpl::m_is_checkpoint |
|
private |
if the output is a checkpoint
◆ m_nextid
int BTDSpeciesHeaderImpl::m_nextid |
◆ m_num_output_int
int BTDSpeciesHeaderImpl::m_num_output_int |
|
private |
Number of integer attributes
◆ m_num_output_real
int BTDSpeciesHeaderImpl::m_num_output_real |
|
private |
Number of real attributes
◆ m_offset_per_box
Vector of particle offset per box of each particle data file for each level
◆ m_particleBoxArray_size
Vector of box array size per for each level
◆ m_particles_per_box
Vector of particles per box for each level
◆ m_real_comp_names
amrex::Vector<std::string> BTDSpeciesHeaderImpl::m_real_comp_names |
|
private |
◆ m_spacedim
int BTDSpeciesHeaderImpl::m_spacedim |
|
private |
Number of dimensions stored in the plotfile, should be same as AMREX_SPACEDIM
◆ m_species_name
std::string BTDSpeciesHeaderImpl::m_species_name |
|
private |
Species name of the particles flushed out
◆ m_total_particles
int BTDSpeciesHeaderImpl::m_total_particles |
Total number of particles of species, m_species_name, in the particle output
◆ m_which_data
Vector of data indices of all particle data for each level
The documentation for this class was generated from the following files: