Structure
This framework contains the following folders and files:
user-material-models/
|-- CMakeLists.txt
|-- doc/
|-- docs/
|-- docs-md/
|-- example-models/
|-- tests/
|-- tools/
| `-- embed_umat_manifest.cmake
`-- user-material/
|-- gpu_error.cpp
|-- gpu_error.h
|-- interface.cpp
|-- interface.h
|-- manifest.json
|-- kernel_mat_XXXX.cu
|-- kernel_mat_XXXX.h
|-- mat_XXXX.cpp
|-- mat_XXXX.h
|-- mat_user.h
|-- mat_user_defines.h
|-- mat_user_functions.h
|-- mat_user_structs_cpu.h
|-- mat_user_structs_gpu.h
`-- umat_manifest.h
- The
docs-mddirectory contains the source Markdown documentation. - The
docsdirectory contains generated documentation output. - The
docdirectory contains the XML sidecar documentation for the example library. - The
example-modelsdirectory contains example models for testing the provided user material models. - The
toolsdirectory contains build helper scripts, including the CMake manifest embedder. - The
user-materialdirectory contains C++ and CUDA source code. CMakeLists.txtdefines the supported build and copies the example library sidecar documentation beside the binary.