From: maier Date: Thu, 20 Jun 2013 20:12:51 +0000 (+0000) Subject: Doxygen already inherits documentation from parent classes X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ef13e7a2f888b1aa1796d2ddfd298e9db19f3d4c;p=dealii-svn.git Doxygen already inherits documentation from parent classes git-svn-id: https://svn.dealii.org/trunk@29844 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/base/function.h b/deal.II/include/deal.II/base/function.h index 28c7a262b2..943a2d8275 100644 --- a/deal.II/include/deal.II/base/function.h +++ b/deal.II/include/deal.II/base/function.h @@ -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 &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 &p, Vector &return_value) const; - /** - * Set values to the point values of the function at the - * points, for the given component. It is assumed that - * values already has the right size, i.e. the same size as the - * points array. - */ virtual void value_list (const std::vector > &points, std::vector &values, const unsigned int component = 0) const; - /** - * Set values to the point values of the function at the - * points, for all components. It is assumed that - * values already has the right size, i.e. the same size as the - * points array. - */ virtual void vector_value_list (const std::vector > &points, std::vector > &values) const; - /** - * Return the gradient of the function at the given point, for the given - * component. - */ virtual Tensor<1,dim> gradient (const Point &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 &p, std::vector > &gradients) const; - /** - * Set gradients to the gradients of the function at the - * points, for the given component. It is assumed that - * values already has the right size, i.e. the same size as the - * points array. - */ virtual void gradient_list (const std::vector > &points, std::vector > &gradients, const unsigned int component = 0) const; - /** - * Set gradients to the gradients of the function at the - * points, for all components. It is assumed that - * gradients already has the right size, i.e. the same size as - * the points array. - * - * The outer loop over gradients 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 > &points, std::vector > > &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 &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 &p, Vector &return_value) const; - /** - * Set values to the point values of the function at the - * points, for the given component. It is assumed that - * values already has the right size, i.e. the same size as the - * points array. - */ virtual void value_list (const std::vector > &points, std::vector &values, const unsigned int component = 0) const; - /** - * Set values to the point values of the function at the - * points, for all components. It is assumed that - * values already has the right size, i.e. the same size as the - * points array. - */ virtual void vector_value_list (const std::vector > &points, std::vector > &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 - * std::map 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: diff --git a/deal.II/include/deal.II/base/tensor_function.h b/deal.II/include/deal.II/base/tensor_function.h index f602eb565d..e8a02aa048 100644 --- a/deal.II/include/deal.II/base/tensor_function.h +++ b/deal.II/include/deal.II/base/tensor_function.h @@ -139,36 +139,15 @@ public: ConstantTensorFunction (const dealii::Tensor &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::value_type value (const Point &p) const; - /** - * Set values to the point values of the function at the - * points. It is assumed that values already has the - * right size, i.e. the same size as the points array. - */ virtual void value_list (const std::vector > &points, std::vector::value_type> &values) const; - /** - * Return the gradient of the function at the given point. - */ virtual typename dealii::TensorFunction::gradient_type gradient (const Point &p) const; - /** - * Set gradients to the gradients of the function at the - * points. It is assumed that values already has the - * right size, i.e. the same size as the points array. - */ virtual void gradient_list (const std::vector > &points, std::vector::gradient_type> &gradients) const;