comment on identify_block

QMCPACK · Apr 11, 2024 · e8594eb · e8594eb
1 parent 42b10ed
commit e8594eb
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/Particle/HDFWalkerOutput.h b/src/Particle/HDFWalkerOutput.h
@@ -50,7 +50,12 @@ class HDFWalkerOutput
   ~HDFWalkerOutput();
 
   /** dump configurations
-   * @param w walkers
+   * Write walkers into hdf file.
+   * The "walkers" dataset typically resides at "state_0/walkers", which
+   *   contains no information about when it was written (at which block).
+   * The identify_block flag appends the block index to uniquely identify
+   *   each walker dump, e.g., "state_0/walkers10" is from block 10.
+   *
    */
   bool dump(const WalkerConfigurations& w, int block, const bool identify_block=false);
   //     bool dump(ForwardWalkingHistoryObject& FWO);