STORMM Source Documentation
Loading...
Searching...
No Matches
stormm::mm::CoordinateFrameReader Struct Reference

Collect C-style pointers for the elements of a read-only CoordinateFrame object. More...

#include <coordinateframe.h>

Public Member Functions

 CoordinateFrameReader (int natom_in, UnitCellType unit_cell_in, const double *xcrd_in, const double *ycrd_in, const double *zcrd_in, const double *umat_in, const double *invu_in, const double *boxdim_in)
 The constructor feeds all arguments straight to the inline initialization list.
 
 CoordinateFrameReader (const CoordinateFrameWriter &cfw)
 
 CoordinateFrameReader (const PhaseSpace &ps, HybridTargetLevel tier=HybridTargetLevel::HOST)
 
 CoordinateFrameReader (const PhaseSpace *ps, HybridTargetLevel tier=HybridTargetLevel::HOST)
 
 CoordinateFrameReader (const PhaseSpace *ps, TrajectoryKind kind, CoordinateCycle orientation, HybridTargetLevel tier=HybridTargetLevel::HOST)
 
 CoordinateFrameReader (const PhaseSpace &ps, TrajectoryKind kind, CoordinateCycle orientation, HybridTargetLevel tier=HybridTargetLevel::HOST)
 
 CoordinateFrameReader (const PhaseSpace *ps, TrajectoryKind kind, HybridTargetLevel tier=HybridTargetLevel::HOST)
 
 CoordinateFrameReader (const PhaseSpace &ps, TrajectoryKind kind, HybridTargetLevel tier=HybridTargetLevel::HOST)
 
 CoordinateFrameReader (const CoordinateFrameReader &original)=default
 Copy and move constructors. The move assignment operator is implicitly deleted.
 
 CoordinateFrameReader (CoordinateFrameReader &&original)=default
 

Public Attributes

const int natom
 The number of atoms in the system.
 
const UnitCellType unit_cell
 The type of unit cell (i.e. ORTHORHOMBIC, could also be NONE)
 
const double * xcrd
 Cartesian X coordinates of all atoms.
 
const double * ycrd
 Cartesian Y coordinates of all atoms.
 
const double * zcrd
 Cartesian Z coordinates of all atoms.
 
const double * umat
 
const double * invu
 Inverse transformation matrix out of box space.
 
const double * boxdim
 Box dimensions (these will be consistent with umat and invu)
 

Detailed Description

Collect C-style pointers for the elements of a read-only CoordinateFrame object.

Constructor & Destructor Documentation

◆ CoordinateFrameReader()

stormm::trajectory::CoordinateFrameReader::CoordinateFrameReader ( int natom_in,
UnitCellType unit_cell_in,
const double * xcrd_in,
const double * ycrd_in,
const double * zcrd_in,
const double * umat_in,
const double * invu_in,
const double * boxdim_in )

The constructor feeds all arguments straight to the inline initialization list.

Overloaded:

Member Data Documentation

◆ umat

const double* stormm::trajectory::CoordinateFrameReader::umat

Transformation matrix to take coordinates into box (fractional) space


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