STORMM Source Documentation
Loading...
Searching...
No Matches
stormm::energy::PMIGridReader Struct Reference

A read-only abstract for the Particle-Mesh Interaction Grid class. More...

#include <pmigrid.h>

Collaboration diagram for stormm::energy::PMIGridReader:

Public Member Functions

 PMIGridReader (NonbondedTheme theme_in, PrecisionModel mode_in, FFTMode fftm_in, int fp_bits_in, int nsys_in, int order_in, const uint4 *dims_in, const double *ddata_in, const float *fdata_in)
 The constructor take a straight list of inputs for all member variables.
 
 PMIGridReader (const PMIGridWriter &w)
 As with some other readers, the writer can be used as a constructor argument.
 
 PMIGridReader (const PMIGridWriter *w)
 
 PMIGridReader (const PMIGridReader &original)=default
 As with other abstracts, the presence of one or more const members forbids definition of the copy and move assignment operators, but with no pointers to repair the default copy and move constructors apply.
 
 PMIGridReader (PMIGridReader &&original)=default
 

Public Attributes

const NonbondedTheme theme
 
const PrecisionModel mode
 The mode in which the object is to operate.
 
const FFTMode fftm
 
const float shacc_fp_scale
 
const int nsys
 
const int order
 
const uint4dims
 
const double * ddata
 
const float * fdata
 

Detailed Description

A read-only abstract for the Particle-Mesh Interaction Grid class.

Constructor & Destructor Documentation

◆ PMIGridReader()

stormm::energy::PMIGridReader::PMIGridReader ( const PMIGridWriter & w)

As with some other readers, the writer can be used as a constructor argument.

Parameters
wA writeable abstract for a pre-existing PMIGrid object

Member Data Documentation

◆ ddata

const double* stormm::energy::PMIGridReader::ddata

Double-precision real data, bounded by indices found in the "w" member of dims

◆ dims

const uint4* stormm::energy::PMIGridReader::dims

Dimensions of each PMI grid. A-, B-, and C-axis lengths are found in the "x", "y", and "z" members of the tuple, with the offset for the start of each grid in the "w" member.

◆ fdata

const float* stormm::energy::PMIGridReader::fdata

Single-precision real data, bounded by indices found in the "w" member of dims

◆ fftm

const FFTMode stormm::energy::PMIGridReader::fftm

The layout of the FFT grid, implying a mode in which the FFT will be carried out

◆ nsys

const int stormm::energy::PMIGridReader::nsys

The number of systems in the synthesis served by this object, and a trusted length for the dims array below

◆ order

const int stormm::energy::PMIGridReader::order

The interpolation order for B-pline mapping of density to the particle-mesh interaction grid

◆ shacc_fp_scale

const float stormm::energy::PMIGridReader::shacc_fp_scale

Scaling factor used in fixed-precision accumulation when accumulating density in shared memory.

◆ theme

const NonbondedTheme stormm::energy::PMIGridReader::theme

The non-bonded property mapped to the particle-mesh interaction grid


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