Public Member Functions

Functions::SquareFunction< dim > Class Template Reference
[Functions]

Inheritance diagram for Functions::SquareFunction< dim >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual double value (const Point< dim > &p, const unsigned int component=0) const
virtual void vector_value (const Point< dim > &p, Vector< double > &values) const
virtual void value_list (const std::vector< Point< dim > > &points, std::vector< double > &values, const unsigned int component=0) const
virtual Tensor< 1, dim > gradient (const Point< dim > &p, const unsigned int component=0) const
virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim > > &gradient) const
virtual void gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim > > &gradients, const unsigned int component=0) const
virtual double laplacian (const Point< dim > &p, const unsigned int component=0) const
virtual void laplacian_list (const std::vector< Point< dim > > &points, std::vector< double > &values, const unsigned int component=0) const

Detailed Description

template<int dim>
class Functions::SquareFunction< dim >

The distance to the origin squared.

This function returns the square norm of the radius vector of a point.

Together with the function, its derivatives and Laplacian are defined.

Author:
: Guido Kanschat, 1999

Definition at line 46 of file function_lib.h.


Member Function Documentation

template<int dim>
virtual double Functions::SquareFunction< dim >::value ( const Point< dim > &  p,
const unsigned int  component = 0 
) const [virtual]

Return the value of the function at the given point. Unless there is only one component (i.e. the function is scalar), you should state the component you want to have evaluated; it defaults to zero, i.e. the first component.

Reimplemented from Function< dim >.

template<int dim>
virtual void Functions::SquareFunction< dim >::vector_value ( const Point< dim > &  p,
Vector< double > &  values 
) const [virtual]

Return all components of a vector-valued function at a given point.

values shall have the right size beforehand, i.e. n_components.

Reimplemented from Function< dim >.

template<int dim>
virtual void Functions::SquareFunction< dim >::value_list ( const std::vector< Point< dim > > &  points,
std::vector< double > &  values,
const unsigned int  component = 0 
) const [virtual]

Set values to the point values of the specified component 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.

Be default, this function repeatedly calls value() for each point separately, to fill the output array.

Reimplemented from Function< dim >.

template<int dim>
virtual Tensor<1,dim> Functions::SquareFunction< dim >::gradient ( const Point< dim > &  p,
const unsigned int  component = 0 
) const [virtual]

Return the gradient of the specified component of the function at the given point.

Reimplemented from Function< dim >.

template<int dim>
virtual void Functions::SquareFunction< dim >::vector_gradient ( const Point< dim > &  p,
std::vector< Tensor< 1, dim > > &  gradients 
) const [virtual]

Return the gradient of all components of the function at the given point.

Reimplemented from Function< dim >.

template<int dim>
virtual void Functions::SquareFunction< dim >::gradient_list ( const std::vector< Point< dim > > &  points,
std::vector< Tensor< 1, dim > > &  gradients,
const unsigned int  component = 0 
) const [virtual]

Set gradients to the gradients of the specified component of the function at the points. It is assumed that gradients already has the right size, i.e. the same size as the points array.

Reimplemented from Function< dim >.

template<int dim>
virtual double Functions::SquareFunction< dim >::laplacian ( const Point< dim > &  p,
const unsigned int  component = 0 
) const [virtual]

Compute the Laplacian of a given component at point p.

Reimplemented from Function< dim >.

template<int dim>
virtual void Functions::SquareFunction< dim >::laplacian_list ( const std::vector< Point< dim > > &  points,
std::vector< double > &  values,
const unsigned int  component = 0 
) const [virtual]

Compute the Laplacian of one component at a set of points.

Reimplemented from Function< dim >.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:13 by doxygen 1.7.2