ParticleTraits< ItoParticle > Struct Reference

ParticleTraits specialization listing the payload columns of ItoParticle. More...

#include <CD_ItoParticle.H>

Static Public Attributes
static constexpr auto	columns
	Payload column member-pointers, listed one field group at a time (SpaceDim entries per vector group).
static constexpr auto	h5Columns = std::make_tuple(D_DECL(&ItoParticle::vx, &ItoParticle::vy, &ItoParticle::vz))
	Subset of payload columns written to HDF5 checkpoints: the per-component velocity.
static constexpr auto	h5PartColumns
	Payload columns written to H5Part visualization files: the transport coefficients, the average energy and the velocity vector (id, position and weight are written automatically; the scratch and previous-position columns are internal and not plotted).

Detailed Description

ParticleTraits specialization listing the payload columns of ItoParticle.

Only the velocity columns are written to HDF5 (h5Columns); position and weight are always checkpointed by the container.

Member Data Documentation

columns

constexpr auto ParticleTraits< ItoParticle >::columns

staticconstexpr

Initial value:

= std::make_tuple(
    &ItoParticle::mobility,
    &ItoParticle::diffusion,
    &ItoParticle::energy,
    &ItoParticle::scratch,
    D_DECL(&ItoParticle::old_x, &ItoParticle::old_y, &ItoParticle::old_z),
    D_DECL(&ItoParticle::vx, &ItoParticle::vy, &ItoParticle::vz),
    D_DECL(&ItoParticle::scratch_x, &ItoParticle::scratch_y, &ItoParticle::scratch_z))

Payload column member-pointers, listed one field group at a time (SpaceDim entries per vector group).

h5PartColumns

constexpr auto ParticleTraits< ItoParticle >::h5PartColumns

staticconstexpr

Initial value:

= std::make_tuple(
    H5Part::Scalar{"mobility", &ItoParticle::mobility},
    H5Part::Scalar{"diffusion", &ItoParticle::diffusion},
    H5Part::Scalar{"energy", &ItoParticle::energy},
    H5Part::Vector{"v", D_DECL(&ItoParticle::vx, &ItoParticle::vy, &ItoParticle::vz)})

Payload columns written to H5Part visualization files: the transport coefficients, the average energy and the velocity vector (id, position and weight are written automatically; the scratch and previous-position columns are internal and not plotted).

---

The documentation for this struct was generated from the following file:

• Source/ItoDiffusion/CD_ItoParticle.H