Add comprehensive documentation to allio.f90 variables - Add detailed…

[k-yoshimi]

Summary

Added comprehensive documentation to variables in allio.f90 to improve code readability and maintainability.

Changes Made

• Added detailed comments explaining namelist parameters and their purposes
• Organized variables by functionality with clear section headers
• Improved code structure for better understanding
• Added comprehensive documentation for all namelist groups:
  • /simulation/ - Simulation control parameters
  • /pseudo/ - Pseudopotential parameters
  • /readio/ - I/O and parallel processing parameters
  • /vmc/ - Variational Monte Carlo parameters
  • /dmclrdmc/ - DMC and LR-DMC parameters
  • /optimization/ - Optimization control parameters
  • /parameters/ - General parameter flags
  • /fitpar/ - Parameter fitting control
  • /dynamic/ - Molecular dynamics parameters
  • /molecul/ - Molecular calculation parameters

Impact

• No compilation errors
• No impact on existing functionality
• Improved code structure for developers
• Better documentation for future maintenance

Testing

• Successfully compiled without errors
• All existing functionality preserved

[k-yoshimi]

Subroutines and Functions Documentation (2f7a71d)

• Added comprehensive comments for matrix contraction subroutines:
  • scontract_genj - Generalized Jastrow matrix contraction
  • scontract_mat_jas - Jastrow matrix contraction
  • scontract_mat_det - Determinant matrix contraction
• Added detailed explanations for update_kgrid subroutine including:
  • Algorithm overview and mathematical background
  • Periodic boundary condition handling
  • Memory optimization strategies
• Added documentation for utility functions:
  • norm_metric - Calculate norm using metric tensor
  • prep_map - Prepare mapping of lattice vectors

[k-yoshimi]

📋 Added File Structure Overview

Added a comprehensive file structure overview at the top of the allio.f90 module.

Added Content:

• File Purpose and Role: Clarified the module's position as the central I/O hub for TurboRVB
• Detailed File Structure: Comprehensive breakdown into 5 main sections
  • Module declaration and imports (Lines 15-30)
  • Variable declarations (Lines 31-1446)
  • Namelist definitions (Lines 1447-1940)
  • Subroutines and functions (Lines 1959-2561)
  • Standalone subroutines (Lines 2587-2614)
• Key Features Description: Module capabilities and characteristics
• Usage Guidelines: How users interact with the module
• Dependencies: Relationships with other modules

Benefits of This Update:

✅ New developers can quickly understand the file structure
✅ Existing developers can easily locate specific functionality
✅ Maintenance becomes clearer with identified sections
✅ Documentation serves as a guide, promoting code understanding

Lines Added:

• 84 lines of detailed explanation added to the file header
• No impact on existing code functionality