diff --git a/mesh_handle/README.md b/mesh_handle/README.md index 570209c131..af68775144 100644 --- a/mesh_handle/README.md +++ b/mesh_handle/README.md @@ -8,6 +8,8 @@ If you want to use the handle, note that is has its own library. Turn the option The folder's most important files are: - The [mesh.hxx](mesh.hxx) defines the mesh of the handle. This is the central file of the mesh handle. +- The [constructor_wrappers.hxx](constructor_wrappers.hxx) allows to define a mesh handle using a cmesh instead of a forest and provides a very small number of examples where the user needs no cmesh. - The [element.hxx](element.hxx) defines the elements (mesh or ghost elements) of the mesh handle. - The [competences.hxx](competences.hxx) defines additional competences/functionality of an element to access additional data. -- The [constructor_wrappers.hxx](constructor_wrappers.hxx) allows to define a mesh handle using a cmesh instead of a forest and provides a very small number of examples where the user needs no cmesh. \ No newline at end of file +- The [competence_pack.hxx](competence_pack.hxx) is needed to pack element or mesh competences to pass it as template parameter to the mesh. +- The [data_handler.hxx](data_handler.hxx) provides competences to work with element data. \ No newline at end of file diff --git a/mesh_handle/competence_pack.hxx b/mesh_handle/competence_pack.hxx index f93c7219a1..e3963566b7 100644 --- a/mesh_handle/competence_pack.hxx +++ b/mesh_handle/competence_pack.hxx @@ -21,7 +21,8 @@ */ /** \file competence_pack.hxx - * Define to pack different competences into one template parameter for the \ref t8_mesh_handle::mesh class. + * Define classes to pack different competences into one template parameter for the \ref t8_mesh_handle::mesh class. + * We have one class for element competences and one for mesh competences. */ #pragma once @@ -29,28 +30,49 @@ #include "competences.hxx" namespace t8_mesh_handle { -/** Class to pack different competences into one template parameter for the \ref mesh class. - * \tparam TCompetence The competences to be packed. +// --- Element competence pack. --- +/** Class to pack different element competences into one template parameter for the \ref mesh class. + * \tparam TElementCompetence The competences to be packed. */ -template