From: bangerth Date: Wed, 30 Apr 2014 10:32:53 +0000 (+0000) Subject: Improve documentation of a function. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4d2d1de8d240441c0d3dda993a5afb6cac735a25;p=dealii-svn.git Improve documentation of a function. git-svn-id: https://svn.dealii.org/trunk@32864 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/fe/fe.h b/deal.II/include/deal.II/fe/fe.h index 1be926e630..530ac15439 100644 --- a/deal.II/include/deal.II/fe/fe.h +++ b/deal.II/include/deal.II/fe/fe.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 1998 - 2013 by the deal.II authors +// Copyright (C) 1998 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -533,13 +533,13 @@ public: const Point &p, const unsigned int component) const; /** - * Check for non-zero values on a face in order to optimize out matrix - * elements. - * * This function returns @p true, if the shape function @p shape_index has - * non-zero values on the face @p face_index. + * non-zero function values somewhere on the face @p face_index. The + * function is typically used to determine whether some matrix elements + * resulting from face integrals can be assumed to be zero and may therefore + * be omitted from integration. * - * A default implementation is provided in this basis class which always + * A default implementation is provided in this basa class which always * returns @p true. This is the safe way to go. */ virtual bool has_support_on_face (const unsigned int shape_index, diff --git a/deal.II/include/deal.II/fe/fe_abf.h b/deal.II/include/deal.II/fe/fe_abf.h index 1a50681b30..c95843b45c 100644 --- a/deal.II/include/deal.II/fe/fe_abf.h +++ b/deal.II/include/deal.II/fe/fe_abf.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2003 - 2013 by the deal.II authors +// Copyright (C) 2003 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -122,13 +122,11 @@ public: virtual std::string get_name () const; /** - * Check whether a shape function - * may be non-zero on a face. + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. * - * Right now, this is only - * implemented for RT0 in - * 1D. Otherwise, returns always - * @p true. + * Right now, this is only implemented for RT0 in 1D. Otherwise, returns + * always @p true. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_dg_vector.h b/deal.II/include/deal.II/fe/fe_dg_vector.h index 0616694148..069f2594cf 100644 --- a/deal.II/include/deal.II/fe/fe_dg_vector.h +++ b/deal.II/include/deal.II/fe/fe_dg_vector.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2010 - 2013 by the deal.II authors +// Copyright (C) 2010 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -81,11 +81,10 @@ public: /** - * Check whether a shape function - * may be non-zero on a face. + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. * - * Returns always - * @p true. + * For this element, we always return @p true. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_dg_vector.templates.h b/deal.II/include/deal.II/fe/fe_dg_vector.templates.h index 8639be4cdb..b404e45703 100644 --- a/deal.II/include/deal.II/fe/fe_dg_vector.templates.h +++ b/deal.II/include/deal.II/fe/fe_dg_vector.templates.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2006 - 2013 by the deal.II authors +// Copyright (C) 2006 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -80,9 +80,8 @@ FE_DGVector::get_dpo_vector (const unsigned int deg) template bool -FE_DGVector::has_support_on_face ( - const unsigned int, - const unsigned int) const +FE_DGVector::has_support_on_face (const unsigned int, + const unsigned int) const { return true; } diff --git a/deal.II/include/deal.II/fe/fe_dgp.h b/deal.II/include/deal.II/fe/fe_dgp.h index 9fd6a5f04a..686ce5ffbe 100644 --- a/deal.II/include/deal.II/fe/fe_dgp.h +++ b/deal.II/include/deal.II/fe/fe_dgp.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2002 - 2013 by the deal.II authors +// Copyright (C) 2002 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -271,17 +271,8 @@ public: FullMatrix &matrix) const; /** - * Check for non-zero values on a face. - * - * This function returns - * @p true, if the shape - * function @p shape_index has - * non-zero values on the face - * @p face_index. - * - * Implementation of the - * interface in - * FiniteElement + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_dgp_monomial.h b/deal.II/include/deal.II/fe/fe_dgp_monomial.h index f6a585c334..74b580c991 100644 --- a/deal.II/include/deal.II/fe/fe_dgp_monomial.h +++ b/deal.II/include/deal.II/fe/fe_dgp_monomial.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2004 - 2013 by the deal.II authors +// Copyright (C) 2004 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -271,17 +271,8 @@ public: FullMatrix &matrix) const; /** - * Check for non-zero values on a face. - * - * This function returns - * @p true, if the shape - * function @p shape_index has - * non-zero values on the face - * @p face_index. - * - * Implementation of the - * interface in - * FiniteElement + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_dgp_nonparametric.h b/deal.II/include/deal.II/fe/fe_dgp_nonparametric.h index 46c5e740e5..0579a743d6 100644 --- a/deal.II/include/deal.II/fe/fe_dgp_nonparametric.h +++ b/deal.II/include/deal.II/fe/fe_dgp_nonparametric.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2002 - 2013 by the deal.II authors +// Copyright (C) 2002 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -324,17 +324,8 @@ public: */ /** - * Check for non-zero values on a face. - * - * This function returns - * @p true, if the shape - * function @p shape_index has - * non-zero values on the face - * @p face_index. - * - * Implementation of the - * interface in - * FiniteElement + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_dgq.h b/deal.II/include/deal.II/fe/fe_dgq.h index ec0c7f9e18..f7039dfaaf 100644 --- a/deal.II/include/deal.II/fe/fe_dgq.h +++ b/deal.II/include/deal.II/fe/fe_dgq.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2001 - 2013 by the deal.II authors +// Copyright (C) 2001 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -312,17 +312,8 @@ public: */ /** - * Check for non-zero values on a face. - * - * This function returns - * @p true, if the shape - * function @p shape_index has - * non-zero values on the face - * @p face_index. - * - * Implementation of the - * interface in - * FiniteElement + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_face.h b/deal.II/include/deal.II/fe/fe_face.h index 2ee366f50f..b94889963d 100644 --- a/deal.II/include/deal.II/fe/fe_face.h +++ b/deal.II/include/deal.II/fe/fe_face.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2009 - 2013 by the deal.II authors +// Copyright (C) 2009 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -96,12 +96,8 @@ public: FullMatrix &matrix) const; /** - * Check for non-zero values on a face. - * * This function returns @p true, if the shape function @p shape_index has - * non-zero values on the face @p face_index. - * - * Implementation of the interface in FiniteElement + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; @@ -199,12 +195,8 @@ public: FullMatrix &matrix) const; /** - * Check for non-zero values on a face. - * * This function returns @p true, if the shape function @p shape_index has - * non-zero values on the face @p face_index. - * - * Implementation of the interface in FiniteElement + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; @@ -407,12 +399,8 @@ public: FullMatrix &matrix) const; /** - * Check for non-zero values on a face. - * * This function returns @p true, if the shape function @p shape_index has - * non-zero values on the face @p face_index. - * - * Implementation of the interface in FiniteElement + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_nedelec.h b/deal.II/include/deal.II/fe/fe_nedelec.h index f09e5010bd..35c4f73d07 100644 --- a/deal.II/include/deal.II/fe/fe_nedelec.h +++ b/deal.II/include/deal.II/fe/fe_nedelec.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2002 - 2013 by the deal.II authors +// Copyright (C) 2002 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -178,8 +178,8 @@ public: /** - * Check whether a shape function - * may be non-zero on a face. + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_q_base.h b/deal.II/include/deal.II/fe/fe_q_base.h index 6bfb8a2ace..1a0b225838 100644 --- a/deal.II/include/deal.II/fe/fe_q_base.h +++ b/deal.II/include/deal.II/fe/fe_q_base.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2000 - 2013 by the deal.II authors +// Copyright (C) 2000 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -87,12 +87,8 @@ public: FullMatrix &matrix) const; /** - * Check for non-zero values on a face. - * * This function returns @p true, if the shape function @p shape_index has - * non-zero values on the face @p face_index. - * - * Implementation of the interface in FiniteElement + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_q_dg0.h b/deal.II/include/deal.II/fe/fe_q_dg0.h index 90b28f579a..358503de0e 100644 --- a/deal.II/include/deal.II/fe/fe_q_dg0.h +++ b/deal.II/include/deal.II/fe/fe_q_dg0.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2012 - 2013 by the deal.II authors +// Copyright (C) 2012 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -302,12 +302,8 @@ public: /** - * Check for non-zero values on a face. - * * This function returns @p true, if the shape function @p shape_index has - * non-zero values on the face @p face_index. - * - * Implementation of the interface in FiniteElement + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_q_hierarchical.h b/deal.II/include/deal.II/fe/fe_q_hierarchical.h index 64d3b644cf..d715e32832 100644 --- a/deal.II/include/deal.II/fe/fe_q_hierarchical.h +++ b/deal.II/include/deal.II/fe/fe_q_hierarchical.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2002 - 2013 by the deal.II authors +// Copyright (C) 2002 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -254,17 +254,8 @@ public: virtual std::string get_name () const; /** - * Check for non-zero values on a face. - * - * This function returns - * @p true, if the shape - * function @p shape_index has - * non-zero values on the face - * @p face_index. - * - * Implementation of the - * interface in - * FiniteElement + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_raviart_thomas.h b/deal.II/include/deal.II/fe/fe_raviart_thomas.h index 01182aef01..0966faef7b 100644 --- a/deal.II/include/deal.II/fe/fe_raviart_thomas.h +++ b/deal.II/include/deal.II/fe/fe_raviart_thomas.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2003 - 2013 by the deal.II authors +// Copyright (C) 2003 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -127,13 +127,11 @@ public: /** - * Check whether a shape function - * may be non-zero on a face. + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. * - * Right now, this is only - * implemented for RT0 in - * 1D. Otherwise, returns always - * @p true. + * Right now, this is only implemented for RT0 in 1D. Otherwise, returns + * always @p true. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; @@ -412,9 +410,10 @@ private: */ static std::vector get_ria_vector (const unsigned int degree); + /** - * Check whether a shape function - * may be non-zero on a face. + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. * * Right now, this is only * implemented for RT0 in diff --git a/deal.II/include/deal.II/fe/fe_system.h b/deal.II/include/deal.II/fe/fe_system.h index 3744e734cc..362e113fa2 100644 --- a/deal.II/include/deal.II/fe/fe_system.h +++ b/deal.II/include/deal.II/fe/fe_system.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 1999 - 2013 by the deal.II authors +// Copyright (C) 1999 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -347,12 +347,8 @@ public: base_element (const unsigned int index) const; /** - * Check for non-zero values on a face. - * * This function returns @p true, if the shape function @p shape_index has - * non-zero values on the face @p face_index. - * - * Implementation of the interface in FiniteElement + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const; diff --git a/deal.II/include/deal.II/fe/fe_trace.h b/deal.II/include/deal.II/fe/fe_trace.h index 86f2be75be..cd9daa02ba 100644 --- a/deal.II/include/deal.II/fe/fe_trace.h +++ b/deal.II/include/deal.II/fe/fe_trace.h @@ -1,7 +1,7 @@ // --------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2000 - 2013 by the deal.II authors +// Copyright (C) 2000 - 2014 by the deal.II authors // // This file is part of the deal.II library. // @@ -75,17 +75,8 @@ public: virtual std::string get_name () const; /** - * Check for non-zero values on a face. - * - * This function returns - * @p true, if the shape - * function @p shape_index has - * non-zero values on the face - * @p face_index. - * - * Implementation of the - * interface in - * FiniteElement + * This function returns @p true, if the shape function @p shape_index has + * non-zero function values somewhere on the face @p face_index. */ virtual bool has_support_on_face (const unsigned int shape_index, const unsigned int face_index) const;