Gromacs  2026.0-dev-20251109-f20ba35
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Static Public Attributes
SwapCoords::Impl Class Reference
+ Collaboration diagram for SwapCoords::Impl:

Description

Main (private) data structure for the position swapping protocol.

Public Member Functions

gmx::ArrayRef< t_swapgrpsplitGroups ()
 Return an ArrayRef to the split groups (a.k.a. channel groups)
 
gmx::ArrayRef< t_swapgrpionGroups ()
 Return an ArrayRef to the ion groups.
 
gmx::ArrayRef< const t_swapgrpionGroups () const
 Return an ArrayRef-to-const to the ion groups.
 
gmx::ArrayRef< t_swapgrpsolventAndIonGroups ()
 Return an ArrayRef to the solvent and ion groups.
 
gmx::ArrayRef< const t_swapgrpsolventAndIonGroups () const
 Return an ArrayRef-to-const to the solvent and ion groups.
 
t_swapgrprequiredGroup (SwapGroupSplittingType groupType)
 Return a reference to the split or solvent group groupType.
 
const t_swapgrprequiredGroup (SwapGroupSplittingType groupType) const
 Return a const reference to the split or solvent group groupType.
 
t_swapgrpionGroup (size_t index)
 Return a reference to the ion group index (i.e within the set of ion groups)
 
const t_swapgrpionGroup (size_t index) const
 Return a const reference to the ion group index (i.e within the set of ion groups)
 

Public Attributes

int swapdim = -1
 One of XX, YY, ZZ.
 
t_pbc pbc
 Needed to make molecules whole before exchanges.
 
FILE * fpout = nullptr
 Output file.
 
std::vector< t_swapgrpgroups
 Groups for channels, solvent and ions.
 
int fluxleak = 0
 Flux not going through any of the channels.
 
real deltaQ = 0._real
 The charge imbalance between the compartments.
 

Static Public Attributes

static constexpr int sc_numRequiredGroups = static_cast<int>(SwapGroupSplittingType::Count)
 Three required groups: channel0, channel1, solvent.
 

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