Reference documentation for deal.II version Git 38fac49 2014-09-30 14:58:30 -0500
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Attributes | List of all members
Functions::FourierSineFunction< dim > Class Template Reference

#include <deal.II/base/function_lib.h>

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

Public Member Functions

 FourierSineFunction (const Point< dim > &fourier_coefficients)
 
virtual double value (const Point< dim > &p, const unsigned int component=0) const
 
virtual Tensor< 1, dim > gradient (const Point< dim > &p, const unsigned int component=0) const
 
virtual double laplacian (const Point< dim > &p, const unsigned int component=0) const
 
- Public Member Functions inherited from Function< dim >
 Function (const unsigned int n_components=1, const doubleinitial_time=0.0)
 
virtual ~Function ()=0
 
Functionoperator= (const Function &f)
 
virtual double value (const Point< dim, double > &p, const unsigned int component=0) const
 
virtual void vector_value (const Point< dim, double > &p, Vector< double > &values) const
 
virtual void value_list (const std::vector< Point< dim, double > > &points, std::vector< double > &values, const unsigned int component=0) const
 
virtual void vector_value_list (const std::vector< Point< dim, double > > &points, std::vector< Vector< double > > &values) const
 
virtual void vector_values (const std::vector< Point< dim, double > > &points, std::vector< std::vector< double > > &values) const
 
virtual Tensor< 1, dim, doublegradient (const Point< dim, double > &p, const unsigned int component=0) const
 
virtual void vector_gradient (const Point< dim, double > &p, std::vector< Tensor< 1, dim, double > > &gradients) const
 
virtual void gradient_list (const std::vector< Point< dim, double > > &points, std::vector< Tensor< 1, dim, double > > &gradients, const unsigned int component=0) const
 
virtual void vector_gradients (const std::vector< Point< dim, double > > &points, std::vector< std::vector< Tensor< 1, dim, double > > > &gradients) const
 
virtual void vector_gradient_list (const std::vector< Point< dim, double > > &points, std::vector< std::vector< Tensor< 1, dim, double > > > &gradients) const
 
virtual double laplacian (const Point< dim, double > &p, const unsigned int component=0) const
 
virtual void vector_laplacian (const Point< dim, double > &p, Vector< double > &values) const
 
virtual void laplacian_list (const std::vector< Point< dim, double > > &points, std::vector< double > &values, const unsigned int component=0) const
 
virtual void vector_laplacian_list (const std::vector< Point< dim, double > > &points, std::vector< Vector< double > > &values) const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from FunctionTime< Number >
 FunctionTime (const Number initial_time=Number(0.0))
 
virtual ~FunctionTime ()
 
Number get_time () const
 
virtual void set_time (const Number new_time)
 
virtual void advance_time (const Number 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)
 

Private Attributes

const Point< dim > fourier_coefficients
 

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
 

Detailed Description

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

Given a wavenumber vector generate a sine function. The wavenumber coefficient is given as a \(d\)-dimensional point \(k\) in Fourier space, and the function is then recovered as \(f(x) = \sin(\sum_i k_i x_i) = Im(\exp(i k.x))\).

The class has its name from the fact that it resembles one component of a Fourier sine decomposition.

Author
Wolfgang Bangerth, 2001

Definition at line 714 of file function_lib.h.

Constructor & Destructor Documentation

template<int dim>
Functions::FourierSineFunction< dim >::FourierSineFunction ( const Point< dim > &  fourier_coefficients)

Constructor. Take the Fourier coefficients in each space direction as argument.

Member Function Documentation

template<int dim>
virtual double Functions::FourierSineFunction< 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.

template<int dim>
virtual Tensor<1,dim> Functions::FourierSineFunction< 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.

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

Compute the Laplacian of a given component at point p.

Member Data Documentation

template<int dim>
const Point<dim> Functions::FourierSineFunction< dim >::fourier_coefficients
private

Stored Fourier coefficients.

Definition at line 756 of file function_lib.h.


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