Skip to content
Snippets Groups Projects
Commit 11e94228 authored by Ansgar Burchardt's avatar Ansgar Burchardt
Browse files

Merge branch 'cherry-pick-1382293c' into 'releases/2.5'

Merge branch 'feature/document-codim-parameter' into 'master'

document sementics of codim parameter for IndexSet::subIndex

If an entity of codimension cc > 0 is passed into IndexSet::subIndex, what
is the semantics of the 'codim' parameter? In DUNE, codimensions are always
with respect to the grid dimension (see method subEntity of reference element).

This patch clearly states that codim is to be understood with respect to the
grid dimension.

See merge request !97

See merge request !112
parents 4c82dae4 41be5c92
No related branches found
No related tags found
Loading
Pipeline #
......@@ -141,7 +141,9 @@ namespace Dune
* \param[in] e reference to codimension cc entity
* \param[in] i number subentity of e within the codimension
* \param[in] codim codimension of the subentity we're interested in
* (must satisfy cc <= codim <= dimension)
*
* \note The parameter <tt>codim</tt> denotes the codimension with respect
* to the grid, i.e., it must satisfy cc <= codim <= dimension.
*
* \return An index in the range 0 ... Max number of entities in set - 1.
*/
......@@ -169,6 +171,9 @@ namespace Dune
* \param[in] i number subentity of e within the codimension
* \param[in] codim codimension of the subentity we're interested in
*
* \note The parameter <tt>codim</tt> denotes the codimension with respect
* to the grid, i.e., it must satisfy cc <= codim <= dimension.
*
* \return An index in the range 0 ... Max number of entities in set - 1.
*/
template< class Entity >
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment