TDycore User Guide!

Contents

• Introduction
• Getting Started
  • Installing PETSc and Dependencies
  • Troubleshooting
  • Building TDycore
  • Running the Regression Tests
• TDycore Development
  • Initializing the TDycore Library
  • Memory Allocation and Deallocation
    • Fortran 90 Interface
  • Timers and Profiling
    • The TDycore Timers Subsystem
    • Function-Level Profiling
    • Manually-Created Timers
    • Profiling Stages
    • Generating Profiling Logs
    • Interpreting Profile Data with TDyProf
    • Generating Scaling Study Plots with TDyPerfPlot
• Style Guide
• Data Types
  • Numeric Datatypes
    • Floating point comparisons
  • Pointers
  • Structs / PODs
  • Classes
    • Class Type (Struct)
    • Class Constructor(s)
    • Class Destructor
    • Class Functions / Methods
    • Polymorphism in C
• Header Files
  • Self-Contained Headers
  • Header File Location
  • Header Guards
  • Including Headers within TDycore Source Code
  • Public and Private Headers, Structs and Classes
  • Functions
  • Global variables
  • Other Symbols
• Scoping
  • Internal Functions
  • Local Variables
  • Scoping Operators
• Functions
  • Length of a Function Body
• Memory Management
• Naming
  • Types
  • Functions
  • Variables and Fields
  • Constants, Enums, Macros
• Comments and Code Markup
  • An Example
• Formatting
• Contributing
  • Developer’s Certificate of Origin 1.1
  • Authorship
• Code of Conduct
  • Our Pledge
  • Our Standards
  • Enforcement Responsibilities
  • Scope
  • Enforcement
  • Enforcement Guidelines
    • 1. Correction
    • 2. Warning
    • 3. Temporary Ban
    • 4. Permanent Ban
  • Attribution
• Changes/Release Notes
  • Current Master
    • Interface changes
    • New features
    • Performance improvements
    • Examples
  • v0.1 (Nov 1, 2020, Just an Example)
    • Interface changes
    • New features
    • Performance improvements
    • Examples
    • Deprecated backends
• Bibliography

Indices and tables

• Index

• Search Page