chombo-discharge
Loading...
Searching...
No Matches
Functions
DischargeIO Namespace Reference

Namespace which encapsulates chombo-discharge IO functionality. More...

Functions

std::string numberFmt (long long n, char a_sep=',') noexcept
 Number formatting method – writes big numbers using an input separator. E.g. the number 123456 is written as 123,456.
 
Vector< std::string > numberFmt (const Vector< long long > &a_numbers, char a_sep=',') noexcept
 Number formatting game. This just prints the number 123456 as 123,456.
 
template<typename P , typename Traits >
void writeH5Part (std::string a_filename, const ParticleContainer< P, Traits > &a_particles, RealVect a_shift, Real a_time) noexcept
 Write an SoA particle container to an H5Part file (quick visualization).
 

Detailed Description

Namespace which encapsulates chombo-discharge IO functionality.

Function Documentation

◆ numberFmt() [1/2]

Vector< std::string > DischargeIO::numberFmt ( const Vector< long long > &  a_numbers,
char  a_sep = ',' 
)
noexcept

Number formatting game. This just prints the number 123456 as 123,456.

Parameters
[in]a_numbersNumbers to format as string with separator
[in]a_sepSeparator
Returns
Return value

◆ numberFmt() [2/2]

std::string DischargeIO::numberFmt ( long long  n,
char  a_sep = ',' 
)
noexcept

Number formatting method – writes big numbers using an input separator. E.g. the number 123456 is written as 123,456.

Parameters
[in]nNumber to format as string with separator
[in]a_sepSeparator
Returns
Return value

◆ writeH5Part()

template<typename P , typename Traits >
void DischargeIO::writeH5Part ( std::string  a_filename,
const ParticleContainer< P, Traits > &  a_particles,
RealVect  a_shift,
Real  a_time 
)
noexcept

Write an SoA particle container to an H5Part file (quick visualization).

Position, id and weight are taken from the container-owned columns and written automatically. The payload datasets are derived declaratively from the optional Traits::h5PartColumns tuple (a list of H5Part::Scalar / H5Part::Vector descriptors pairing a dataset name with the selecting payload member pointer(s)); if Traits::h5PartColumns is not declared, only id/position/weight are written. Each vector descriptor is written as name-x/name-y/name-z.

Parameters
[in]a_filenameFile name.
[in]a_particlesSoA particle container.
[in]a_shiftParticle position shift (subtracted from the written positions).
[in]a_timePhysical time.
Template Parameters
PPayload type of the container.
TraitsColumn descriptor for the payload.