HOPR Documentation Logo
v1.2.1

User Guide

  • User Guide
    • 1. Installation
      • 1.1. Executable download
        • 1.1.1. Docker
        • 1.1.2. AppImage
      • 1.2. Prerequisites
        • 1.2.1. Compilers
      • 1.3. Required Libraries
        • 1.3.1. Installing/setting up GCC
        • 1.3.2. Installing/setting up HOPR
        • 1.3.3. Installing/setting up HDF5
      • 1.4. Troubleshooting
        • 1.4.1. Wrongly set HDF5_ROOT variable
        • 1.4.2. Pre-compiled HDF5 via Spack and/or cmake
      • 1.5. Testing HOPR
    • 2. HOPR HDF5 Curved Mesh Format
      • 2.1. Introduction
        • 2.1.1. Main Idea Behind the Mesh Format
      • 2.2. File Description
        • 2.2.1. Global Attributes
        • 2.2.2. Data Arrays
        • 2.2.3. Example Mesh
        • 2.2.4. Array Definitions
      • 2.3. Parallel Read-in
      • 2.4. Element Definitions
        • 2.4.1. Element Types
        • 2.4.2. Element High Order Nodes
        • 2.4.3. Element Corners, Sides
        • 2.4.4. Element Connectivity
      • 2.5. Additional Extensions: Hanging Node Interface
        • 2.5.1. Changes to Existing Data Format
        • 2.5.2. Additional Information for Octrees
    • 3. Appendix
      • 3.1. Tested compiler combinations

Developer Guide

  • Developer Guide
    • 1. Github Workflow
      • 1.1. Issues & Milestones
      • 1.2. Merge Request
      • 1.3. Release and deploy
        • 1.3.1. Release Tag
        • 1.3.2. Collaborative Numerics Group
        • 1.3.3. GitHub
    • 2. Style Guide
      • 2.1. Header of Functions and Subroutines
      • 2.2. Variables
      • 2.3. Functions and Control Structures
      • 2.4. Workflow Description
    • 3. Building the Documentation
    • 4. Compiler Options
    • 5. Building the AppImage Executable
    • 6. Troubleshooting
      • 6.1. dlopen(): error loading libfuse.so.2
    • 7. Markdown Examples
      • 7.1. hyperlinks
      • 7.2. Code environment
      • 7.3. Equations
      • 7.4. Bibtex, cite
      • 7.5. section references
      • 7.6. Figures, caption
      • 7.7. tables
      • 7.8. unnumbered section headings
      • 7.9. Code blocks for various languages

References

  • References
HOPR Documentation
  • Search

© Copyright 2022, HOPR Developers. Revision cf452c82.

Built with Sphinx using a theme provided by Read the Docs.