This document provides a guide to the style used in this project.
We utilize ClangFormat to automate code formatting. Please format your code before pushing and/or creating a pull request.
In general, we stick to the following naming conventions:
snake_casefor variables, functions, and filenames
PascalCasefor classes and structs
ALL_CAPSfor constants and enum members
m_prefix for class member variables (if the member is not public)
member()to get a class member variable (if the member is not public)
set_member()to set a class member variable (if the member is not public)
vertex rest positions/material coordinates:
mesh edge matrix:
mesh face matrix:
element vertices: we use a numeral suffix (e.g.,
e1for the end-points of an edge)
edge-edge pairings: suffix of
continuous collision detection pairs: suffix of
_t0for starting values and
_t1for end values
We use Doxygen to generate documentation. Please document your code before pushing and/or creating a pull request.