🌊 v2.5: ElastoFlow - Complete 2D/3D Viscoelastic Framework

🚀 Release v2.5 - Improved Documentation and Code Organization

📝 Major Changes

• Complete documentation overhaul for viscoelastic solvers
• Added mathematical documentation for log-conformation approach
• Improved code organization and constants management
• License updated to GPLv3 to align with Basilisk

🔍 Detailed Changes

Documentation Improvements

• Added comprehensive mathematical documentation explaining log-conformation methodology
• Enhanced implementation documentation for better code understanding
• Reorganized documentation structure for better readability
• Updated documentation links to use proper markdown format

Code Organization

• Refactored viscoelastic constants for better maintainability
• Added safeguards to prevent incorrect 3D usage
• Improved version tracking and change log structure

Other Changes

• Updated license to GPLv3 to maintain compatibility with Basilisk codebase
• Version bumped to 2.5 in solver headers
• Added clearer explanation of G-λ formulation and stress handling

🔧 Technical Notes

• The viscoelastic solver now includes better documentation of implementation details
• Added warnings and checks for proper dimensional usage
• Improved organization of mathematical constants and parameters

📋 Compatibility

• This release maintains backward compatibility with existing implementations
• Users should review the updated documentation for best practices

🙏 Acknowledgments

• Thanks to all contributors who helped improve the documentation
• Special thanks to the Basilisk community

---

Full Changelog: v2.0.1...v2.5

🌊 v2.0.1: ElastoFlow - Complete 2D/3D Viscoelastic Framework

Fixes a minor bug, AThTh not Aqq.

For main details, see v2.0: https://github.com/comphy-lab/Viscoelastic3D/releases/tag/v2.0

🌊 v2.0: ElastoFlow - Complete 2D/3D Viscoelastic Framework

Enhanced Documentation and Robustness Update

Building upon our successful v1.0 release, this version brings significant improvements to documentation, code clarity, and robustness of the log-conformation viscoelastic solver. Also made version tag consistent across main source files: log-conform-viscoelastic-scalar-2D.h and log-conform-viscoelastic-scalar-3D.

✨ Key Improvements

Documentation Enhancements

• Added comprehensive documentation for the log-conformation method in 2D implementation
• Synchronized documentation between 2D and 3D versions for consistency
• Fixed documentation typos in log-conform-viscoelastic-scalar-3D.h

Code Robustness

• Added validation check for negative eigenvalues in diagonalization_2D function
• Introduced new initialization functions:
  • init_pseudo_v for pseudo vectors
  • init_pseudo_t for pseudo tensors
• Enhanced computation of B tensor components
• Improved transformation of rotation tensor Omega to original coordinate system

Architecture Improvements

• Refactored tensor operations using intermediate tensor structure A
• Enforced explicit symmetry in tensor operations
• Added TODO markers for future transition to fully tensor-based formulation

🔍 Technical Details

• Enhanced matrix algebra implementation in both 2D and 3D calculations
• Improved intermediate variable handling for better clarity
• Better error reporting for negative eigenvalue cases

🎯 Future Development

• Planned transition to a fully tensor-based formulation
• Continued optimization of computational efficiency
• Further documentation improvements

🔄 Compatibility

• Fully compatible with previous v1.0 implementations
• Maintains support for both 2D and 3D simulations
• Preserves existing functionality while improving robustness

---

For a complete list of changes, please refer to the commit history and PR #14.

📚 Previous Release (v1.0) Highlights

• Complete scalar implementation of log-conformation method for 3D viscoelastic fluid simulations
• Optimized matrix operations in 3D calculations
• Enhanced initialization functions
• Improved error handling
• Optimized Omega tensor calculations
• Performance improvements in acceleration term calculations

🌊 v1.0: ElastoFlow - Complete 2D/3D Viscoelastic Framework

🚀 Introducing a major update to our viscoelastic fluid simulation framework!
🎯 Key Features:

✨ New 3D Implementation: Complete scalar implementation of log-conformation method for 3D viscoelastic fluid simulations
🔧 Enhanced Matrix Algebra: Thoroughly rechecked and optimized matrix operations in 3D calculations
🎮 Improved Control: New initialization functions for pseudo vectors and tensors in both 2D and 3D
🛡️ Better Error Handling: Added checks for negative eigenvalues with detailed error reporting
🔄 Optimized Omega Tensor: Improved calculations with better intermediate variable handling
🚀 Performance: Simplified acceleration term calculations for better efficiency

🐛 Bug Fixes:

Corrected matrix algebra implementation in 3D calculations
Fixed issues with rotation tensor computations
Resolved edge cases in eigenvalue calculations

📚 Documentation:

Added comprehensive verification notes
Improved inline documentation for better maintainability
Added detailed TODOs for future development

💡 Under the Hood:

Reorganized code structure for better clarity
Added compatibility notes for axisymmetric cases