]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doxygen already inherits documentation from parent classes
authormaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 20 Jun 2013 20:12:51 +0000 (20:12 +0000)
committermaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 20 Jun 2013 20:12:51 +0000 (20:12 +0000)
git-svn-id: https://svn.dealii.org/trunk@29844 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/base/function.h
deal.II/include/deal.II/base/tensor_function.h

index 28c7a262b2235fa940034369da911629efc214ba..943a2d8275eaeb4ca8885fd60f31bebc2f76fa89 100644 (file)
@@ -328,74 +328,33 @@ public:
 
   /**
    * Virtual destructor; absolutely necessary in this case.
+   *
    */
   virtual ~ZeroFunction ();
 
-  /**
-   * Return the value of the function at the given point for one component.
-   */
   virtual double value (const Point<dim>   &p,
                         const unsigned int  component) const;
 
-  /**
-   * Return the value of the function at the given point for all
-   * components.
-   */
   virtual void vector_value (const Point<dim> &p,
                              Vector<double>   &return_value) const;
 
-  /**
-   * Set <tt>values</tt> to the point values of the function at the
-   * <tt>points</tt>, for the given component. It is assumed that
-   * <tt>values</tt> already has the right size, i.e. the same size as the
-   * <tt>points</tt> array.
-   */
   virtual void value_list (const std::vector<Point<dim> > &points,
                            std::vector<double>            &values,
                            const unsigned int              component = 0) const;
 
-  /**
-   * Set <tt>values</tt> to the point values of the function at the
-   * <tt>points</tt>, for all components. It is assumed that
-   * <tt>values</tt> already has the right size, i.e. the same size as the
-   * <tt>points</tt> array.
-   */
   virtual void vector_value_list (const std::vector<Point<dim> > &points,
                                   std::vector<Vector<double> >   &values) const;
 
-  /**
-   * Return the gradient of the function at the given point, for the given
-   * component.
-   */
   virtual Tensor<1,dim> gradient (const Point<dim> &p,
                                   const unsigned int component = 0) const;
 
-  /**
-   * Return the gradient of the specified component of the function at the
-   * given point, for all components.
-   */
   virtual void vector_gradient (const Point<dim>            &p,
                                 std::vector<Tensor<1,dim> > &gradients) const;
 
-  /**
-   * Set <tt>gradients</tt> to the gradients of the function at the
-   * <tt>points</tt>, for the given component. It is assumed that
-   * <tt>values</tt> already has the right size, i.e. the same size as the
-   * <tt>points</tt> array.
-   */
   virtual void gradient_list (const std::vector<Point<dim> > &points,
                               std::vector<Tensor<1,dim> >    &gradients,
                               const unsigned int              component = 0) const;
 
-  /**
-   * Set <tt>gradients</tt> to the gradients of the function at the
-   * <tt>points</tt>, for all components. It is assumed that
-   * <tt>gradients</tt> already has the right size, i.e. the same size as
-   * the <tt>points</tt> array.
-   *
-   * The outer loop over <tt>gradients</tt> is over the points in the list,
-   * the inner loop over the different components of the function.
-   */
   virtual void vector_gradient_list (const std::vector<Point<dim> >            &points,
                                      std::vector<std::vector<Tensor<1,dim> > > &gradients) const;
 };
@@ -441,45 +400,19 @@ public:
    */
   virtual ~ConstantFunction ();
 
-  /**
-   * Return the value of the function at the given point for one component.
-   */
   virtual double value (const Point<dim>   &p,
                         const unsigned int  component) const;
 
-  /**
-   * Return the value of the function at the given point for all
-   * components.
-   */
   virtual void   vector_value (const Point<dim> &p,
                                Vector<double>   &return_value) const;
 
-  /**
-   * Set <tt>values</tt> to the point values of the function at the
-   * <tt>points</tt>, for the given component. It is assumed that
-   * <tt>values</tt> already has the right size, i.e. the same size as the
-   * <tt>points</tt> array.
-   */
   virtual void value_list (const std::vector<Point<dim> > &points,
                            std::vector<double>            &values,
                            const unsigned int              component = 0) const;
 
-  /**
-   * Set <tt>values</tt> to the point values of the function at the
-   * <tt>points</tt>, for all components. It is assumed that
-   * <tt>values</tt> already has the right size, i.e. the same size as the
-   * <tt>points</tt> array.
-   */
   virtual void vector_value_list (const std::vector<Point<dim> > &points,
                                   std::vector<Vector<double> >   &values) const;
 
-  /**
-   * Determine an estimate for the memory consumption (in bytes) of this
-   * object. Since sometimes the size of objects can not be determined
-   * exactly (for example: what is the memory consumption of an STL
-   * <tt>std::map</tt> type with a certain number of elements?), this is
-   * only an estimate. however often quite close to the true value.
-   */
   std::size_t memory_consumption () const;
 
 protected:
index f602eb565da8093cacc786fa96535709dbfe3529..e8a02aa0483f164f0d40273bf3bc2ec9f7b9b58d 100644 (file)
@@ -139,36 +139,15 @@ public:
   ConstantTensorFunction (const dealii::Tensor<rank, dim> &value,
                           const double initial_time = 0.0);
 
-  /**
-   * Virtual destructor; absolutely necessary in this case, as classes are
-   * usually not used by their true type, but rather through pointers to
-   * this base class.
-   */
   virtual ~ConstantTensorFunction ();
 
-  /**
-   * Return the value of the function at the given point.
-   */
   virtual typename dealii::TensorFunction<rank, dim>::value_type value (const Point<dim> &p) const;
 
-  /**
-   * Set <tt>values</tt> to the point values of the function at the
-   * <tt>points</tt>.  It is assumed that <tt>values</tt> already has the
-   * right size, i.e.  the same size as the <tt>points</tt> array.
-   */
   virtual void value_list (const std::vector<Point<dim> > &points,
                            std::vector<typename dealii::TensorFunction<rank, dim>::value_type> &values) const;
 
-  /**
-   * Return the gradient of the function at the given point.
-   */
   virtual typename dealii::TensorFunction<rank, dim>::gradient_type gradient (const Point<dim> &p) const;
 
-  /**
-   * Set <tt>gradients</tt> to the gradients of the function at the
-   * <tt>points</tt>.  It is assumed that <tt>values</tt> already has the
-   * right size, i.e.  the same size as the <tt>points</tt> array.
-   */
   virtual void gradient_list (const std::vector<Point<dim> > &points,
                               std::vector<typename dealii::TensorFunction<rank, dim>::gradient_type> &gradients) const;
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.