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

A lean, read-only abstract for the LocalExclusionMask class. More...

#include <local_exclusionmask.h>

Collaboration diagram for stormm::mm::LocalExclusionMaskReader:

Public Member Functions

 LocalExclusionMaskReader (const int *prof_idx_in, const ullint *profiles_in, const uint2 *aux_masks_in)
 The constructor for this and other abstracts takes input arguments for each member variable. It is lean, and best used in concert with the topology synthesis or cell grid with which it is associated, so that the system atom limits are most accessible.
 
 LocalExclusionMaskReader (const LocalExclusionMaskReader &original)=default
 As with other abstracts, the copy and move constructors are valid and can be taken in their default forms. However, the coyp and move assignment operators are invalidated by the presence of const members.
 
 LocalExclusionMaskReader (LocalExclusionMaskReader &&original)=default
 

Public Attributes

const int * prof_idx
 Profile indices of each atom.
 
const ullint * profiles
 
const uint2aux_masks
 

Detailed Description

A lean, read-only abstract for the LocalExclusionMask class.

Constructor & Destructor Documentation

◆ LocalExclusionMaskReader()

stormm::energy::LocalExclusionMaskReader::LocalExclusionMaskReader ( const LocalExclusionMaskReader & original)
default

As with other abstracts, the copy and move constructors are valid and can be taken in their default forms. However, the coyp and move assignment operators are invalidated by the presence of const members.

Parameters
originalThe original object to copy or move

Member Data Documentation

◆ aux_masks

const uint2* stormm::energy::LocalExclusionMaskReader::aux_masks

Auxiliary exclusion masks, with the offset from the index (central) atom in the "x" member and the mask of 32 bits in the "y" member

◆ profiles

const ullint* stormm::energy::LocalExclusionMaskReader::profiles

Atom profiles, containing the mode and various other bit packed elements to support multiple exclusion mask patterns


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