ug4 - Documentation

About

ug4 has been written and is still developed at the Goethe Center for Scientific Computing at the University of Frankfurt, Germany (http://www.g-csc.de).

https://github.com/UG4/ugcore gives a quick overview on how to obtain and to install ug4. Several example applications are described and tools for pre- and postprocessing are linked.

---

What is ug4?

ug4 is a simulation framework, targeted at the solution of differential equations on unstructured hybrid grids in 1, 2 and 3 dimensions on systems reaching from laptops to massively parallel systems. ug4 is written in C++, striving for a flexible, yet fast and robust simulation environment ... [more]

---

User Manual

• Overview
  • Introduction
  • Cite UG4
  • Ideas behind ug4
  • Software Architecture
  • Background
• Setup and Installation
  • Building UG4
    • BASH Tools
    • uginstall - Scripts for installation
  • Prerequisites and Recommended Tools
    • Prerequisites on Linux / Unix
    • Prerequisites on Mac OSX
    • Prerequisites on Windows
    • Installation on Parallel Computers
    • Cekon, Cesari, Hermit, JuQueen
  • Coupling of HLibPro
  • How to build UG for VRL
    • How to build UG for VRL for Windows
    • Build UG for VRL for Linux and Mac with a script
• Usage
  • ugshell
  • Tutorials
    • Scripting Tutorials
    • Profiling ug4
    • Scalability Tests
    • Some information about Shell and Linux
      
  • Parallel Usage
    • Parallel computing
    • ugsubmit - Job Scheduling on Clusters
    • Parallel Rendering
      
  • ug4 and vrl
    • How to build UG for VRL for Windows
    • Build UG for VRL for Linux and Mac with a script
  • ug4-Scripting Reference Documentation
  • Provided LUA Scripts
    
  • BASH Tools
  • LUA2C/LUA2VM
• Development
  • Introduction for C++ Programmers
  • Central modules of ugbase
    • libAlgebra
    • libDiscretization
    • libGrid
    • ug4-Registry
  • Plugins
  • Unit Tests
  • Tips and Guidelines
    • Developing with the Eclipse IDE
    • Developing with the Netbeans IDE
    • Coding Style
    • Developer Team Communication
    • Compilation Optimizations
    • Doxygen Quick Reference
    • pageUsingGit
    • SSH
    • pageUG4SVN
  • Debugging UG4's C/C++ Code
• Troubleshooting
• Copyrights and Licenses
  • License
  • External Libraries