🚀 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