Reference documentation for deal.II version SVN Revision 32792
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
Functions::CosineGradFunction< dim > Class Template Reference

#include <function_lib.h>

Inheritance diagram for Functions::CosineGradFunction< dim >:
[legend]

Public Member Functions

 CosineGradFunction ()
 
virtual double value (const Point< dim > &p, const unsigned int component) 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) const
 
virtual void vector_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< double > > &values) const
 
virtual Tensor< 1, dim > gradient (const Point< dim > &p, const unsigned int component) const
 
virtual void gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim > > &gradients, const unsigned int component) const
 
virtual void vector_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim > > > &gradients) const
 
virtual double laplacian (const Point< dim > &p, const unsigned int component) const
 
- Public Member Functions inherited from Function< dim >
 Function (const unsigned int n_components=1, const double initial_time=0.0)
 
virtual ~Function ()=0
 
Functionoperator= (const Function &f)
 
virtual void vector_values (const std::vector< Point< dim > > &points, std::vector< std::vector< double > > &values) const
 
virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim > > &gradients) const
 
virtual void vector_gradients (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim > > > &gradients) const
 
virtual void vector_laplacian (const Point< dim > &p, Vector< double > &values) const
 
virtual void laplacian_list (const std::vector< Point< dim > > &points, std::vector< double > &values, const unsigned int component=0) const
 
virtual void vector_laplacian_list (const std::vector< Point< dim > > &points, std::vector< Vector< double > > &values) const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from FunctionTime
 FunctionTime (const double initial_time=0.0)
 
virtual ~FunctionTime ()
 
double get_time () const
 
virtual void set_time (const double new_time)
 
virtual void advance_time (const double delta_t)
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Additional Inherited Members

- Public Attributes inherited from Function< dim >
const unsigned int n_components
 
- Static Public Attributes inherited from Function< dim >
static const unsigned int dimension = dim
 

Detailed Description

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

Gradient of the cosine-shaped pillow function.

This is a vector-valued function with dim components, the gradient of CosineFunction. On the square [-1,1], it has tangential boundary conditions zero. Thus, it can be used to test implementations of Maxwell operators without bothering about boundary terms.

Author
Guido Kanschat, 2010

Definition at line 274 of file function_lib.h.

Constructor & Destructor Documentation

template<int dim>
Functions::CosineGradFunction< dim >::CosineGradFunction ( )

Constructor, creating a function with dim components.

Member Function Documentation

template<int dim>
virtual double Functions::CosineGradFunction< dim >::value ( const Point< dim > &  p,
const unsigned int  component 
) 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::CosineGradFunction< 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.

The default implementation will call value() for each component.

Reimplemented from Function< dim >.

template<int dim>
virtual void Functions::CosineGradFunction< dim >::value_list ( const std::vector< Point< dim > > &  points,
std::vector< double > &  values,
const unsigned int  component 
) 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.

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

Reimplemented from Function< dim >.

template<int dim>
virtual void Functions::CosineGradFunction< dim >::vector_value_list ( const std::vector< Point< dim > > &  points,
std::vector< Vector< double > > &  values 
) const
virtual

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, and that all elements be vectors with the same number of components as this function has.

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

Reimplemented from Function< dim >.

template<int dim>
virtual Tensor<1,dim> Functions::CosineGradFunction< dim >::gradient ( const Point< dim > &  p,
const unsigned int  component 
) 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::CosineGradFunction< dim >::gradient_list ( const std::vector< Point< dim > > &  points,
std::vector< Tensor< 1, dim > > &  gradients,
const unsigned int  component 
) 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 void Functions::CosineGradFunction< dim >::vector_gradient_list ( const std::vector< Point< dim > > &  points,
std::vector< std::vector< Tensor< 1, dim > > > &  gradients 
) const
virtual

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.

Reimplemented from Function< dim >.

template<int dim>
virtual double Functions::CosineGradFunction< dim >::laplacian ( const Point< dim > &  p,
const unsigned int  component 
) const
virtual

Compute the Laplacian of a given component at point p.

Reimplemented from Function< dim >.


The documentation for this class was generated from the following file: