From 9a65693ad0d7849881de0ed01ca73ed3e2fd97b6 Mon Sep 17 00:00:00 2001 From: bangerth Date: Fri, 7 Dec 2012 09:46:13 +0000 Subject: [PATCH] Update documentation. git-svn-id: https://svn.dealii.org/trunk@27777 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/fe/fe_base.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/deal.II/include/deal.II/fe/fe_base.h b/deal.II/include/deal.II/fe/fe_base.h index 0fb62efe65..f40b303b3e 100644 --- a/deal.II/include/deal.II/fe/fe_base.h +++ b/deal.II/include/deal.II/fe/fe_base.h @@ -584,6 +584,19 @@ public: * return the index of the same * degree of freedom on the cell. * + * @param face_index The index of the degree of freedom on a face. + * This index must be between zero and dofs_per_face. + * @param face The number of the face this degree of freedom lives on. + * This number must be between zero and GeometryInfo::faces_per_cell. + * @param face_orientation One part of the description of the orientation + * of the face. See @ref GlossFaceOrientation . + * @param face_flip One part of the description of the orientation + * of the face. See @ref GlossFaceOrientation . + * @param face_rotation One part of the description of the orientation + * of the face. See @ref GlossFaceOrientation . + * @return The index of this degree of freedom within the set + * of degrees of freedom on the entire cell. The returned value + * will be between zero and dofs_per_cell. */ unsigned int face_to_cell_index (const unsigned int face_index, const unsigned int face, -- 2.39.5