Block-Structured AMR Software Framework
amrex::ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayInt > Struct Template Reference

A struct used to pass initial data into the various Init methods. This struct is used to pass initial data into the various Init methods of the particle container. That data should be initialized in the order real struct data, int struct data, real array data, int array data. If fewer components are specified than the template parameters specify for, a given component, then the extra values will be set to zero. If more components are specified, it is a compile-time error. More...

#include <AMReX_ParticleContainer.H>

Public Attributes

std::array< double, NStructReal > real_struct_data
 
std::array< int, NStructInt > int_struct_data
 
std::array< double, NArrayReal > real_array_data
 
std::array< int, NArrayInt > int_array_data
 

Detailed Description

template<int NStructReal, int NStructInt, int NArrayReal, int NArrayInt>
struct amrex::ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayInt >

A struct used to pass initial data into the various Init methods. This struct is used to pass initial data into the various Init methods of the particle container. That data should be initialized in the order real struct data, int struct data, real array data, int array data. If fewer components are specified than the template parameters specify for, a given component, then the extra values will be set to zero. If more components are specified, it is a compile-time error.

Example usage:

ParticleInitType<0, 2, 4, 1> pdata = {{}, {7, 9}, {1.5, 2.5, 3.5, 4.5}, {11}};

Member Data Documentation

◆ int_array_data

template<int NStructReal, int NStructInt, int NArrayReal, int NArrayInt>
std::array<int, NArrayInt > amrex::ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayInt >::int_array_data

◆ int_struct_data

template<int NStructReal, int NStructInt, int NArrayReal, int NArrayInt>
std::array<int, NStructInt > amrex::ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayInt >::int_struct_data

◆ real_array_data

template<int NStructReal, int NStructInt, int NArrayReal, int NArrayInt>
std::array<double, NArrayReal > amrex::ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayInt >::real_array_data

◆ real_struct_data

template<int NStructReal, int NStructInt, int NArrayReal, int NArrayInt>
std::array<double, NStructReal> amrex::ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayInt >::real_struct_data

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