Developer guide

• Coding Guidelines
  • General Guidelines regarding Coding in C++
  • 4C-specific coding guidelines
  • 4C-specific Naming Conventions
  • Directory structure
• Testing
  • Overview on testing mechanisms
• CMake
  • Configuration from a terminal
  • Defining your own CMake presets
  • Reference of all CMake variables
  • Configuration from the IDE
  • For CMake maintainers
• Debugging and Profiling Tools
  • Overview of debugging and profiling tools
  • Useful options for Debugging with gdb (or your IDE)
  • Code profiling with callgrind
  • Configure and build for profiling
  • Run simulation with valgrind
  • Examine results with kcachegrind
  • Teuchos Time Monitor
  • Add a timer for a method in 4C
  • How to interpret the output of the TimeMonitor
• Documenting the code with Doxygen
  • What is Doxygen and why does 4C rely on it?
  • 4C’s Policy
  • How to write useful Doxygen documentation
  • What needs to be documented?
  • Building the Doxygen Documentation
  • Choosing good names to simplify documentation
• Coverage report
  • Best practices
  • Code coverage
  • Some technical details
• Speed up recompilation using ccache
  • Enforce a complete recompilation
• Cloning 4C on a cluster
  • Method 1: Clone 4C repository from GitHub
  • Method 2: Clone 4C from local workstation
  • Method 3: Clone 4C from local workstation via reverse ssh tunnel
• Distributed computations with the Petra Object Model
  • Petra Object Model
  • Types of Maps – a linear algebra point of view
  • Types of Maps – a finite element point of view
• Development of specific code blocks
  • Development of material models
• How to release 4C