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 1be926e630b3694c7133ce09a97ab4673f7f5b34..530ac15439f65390e4e312715ecf710a8b86c81d 100644 (file)
--- 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<dim>   &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 1a50681b304493b41f15534b2c531bb8f380f205..c95843b45c81b58d0e7c85dd474dcb3f1722bb88 100644 (file)
--- 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 061669414872478676eadc7bac349510287a97a3..069f2594cf93ed0ac9492a46c6a979f366bf4726 100644 (file)
--- 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 8639be4cdbae13db444e67544cdcbf958f4defa0..b404e45703b08e6f9981e8dbfaa7144ef167616b 100644 (file)
--- 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<POLY,dim,spacedim>::get_dpo_vector (const unsigned int deg)
 
 template <class POLY, int dim, int spacedim>
 bool
-FE_DGVector<POLY,dim,spacedim>::has_support_on_face (
-  const unsigned int,
-  const unsigned int) const
+FE_DGVector<POLY,dim,spacedim>::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 9fd6a5f04a7f87930a61970c484574343f65f95d..686ce5ffbe837f96f3af498fa0d478f8b20e8349 100644 (file)
--- 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<double>       &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 f6a585c3343a396edaae7edaa06d5340e509c01f..74b580c991d96f1c40fa1920655428e42e724dc9 100644 (file)
--- 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<double>       &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 46c5e740e5c6bd3c771b0c02284a25a37a03a351..0579a743d6fea0f4f2844d11b712a0686681e77f 100644 (file)
--- 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 ec0c7f9e18abd3049e31bc6a43a83cd1d8ed60d3..f7039dfaaf15597b92fd57b20f63f8f1cf431f18 100644 (file)
--- 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 2ee366f50fb55bd77443d0eba8320d3848d3e538..b94889963ddcf8dc94206967bd40d327be92c1f8 100644 (file)
--- 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<double>       &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<double>       &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<double>       &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 f09e5010bdb333cb1b71996b9b8a5ebd6c4c3980..35c4f73d079f02a75ff21bb04af587e898630595 100644 (file)
--- 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 6bfb8a2ace2cabdd67e843670e866a970c8e02d4..1a0b225838857825690fa8f13caa0cdc344c0150 100644 (file)
--- 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<double>       &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 90b28f579acfb6cefe7e32fbc463ac1496490880..358503de0e48cd8fe70a18e38cdb57e65179e325 100644 (file)
--- 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 64d3b644cf97c1d6f1e6fc8618875c3d36321762..d715e328326a98f258c24bdfe3bad77a8e11e9d2 100644 (file)
--- 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 01182aef014b9c49e754e6613b2a373474408ca1..0966faef7b43e3dfbfd378f6f4a92ee80ba1e7ac 100644 (file)
--- 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<bool>
   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 3744e734cc19d95e731716a6a2ea108f585610f2..362e113fa2fbce659d4295a654c6a083c4f2eefa 100644 (file)
--- 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 86f2be75becd0e01fc107d39cd39ab563e5c4df5..cd9daa02bac0b527f8e24030dda6ab5d81533754 100644 (file)
--- 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;