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

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

List of all members.

Public Member Functions

 CutOffFunctionBase (const double radius=1., const Point< dim >=Point< dim >(), const unsigned int n_components=1, const unsigned int select=CutOffFunctionBase< dim >::no_component)
void new_center (const Point< dim > &p)
void new_radius (const double r)

Static Public Attributes

static const unsigned int no_component = numbers::invalid_unsigned_int

Protected Attributes

Point< dim > center
double radius
const unsigned int selected

Detailed Description

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

Base function for cut-off function. This class stores the center and the radius of the supporting ball of a cut-off function. It also stores the number of the non-zero component, if the function is vector-valued.

Author:
Guido Kanschat, 2002

Constructor & Destructor Documentation

template<int dim>
Functions::CutOffFunctionBase< dim >::CutOffFunctionBase ( const double  radius = 1.,
const Point< dim >  = Point< dim >(),
const unsigned int  n_components = 1,
const unsigned int  select = CutOffFunctionBase< dim >::no_component 
)

Constructor. Arguments are the center of the ball and its radius.

If an argument select is given and not -1, the cut-off function will be non-zero for this component only.


Member Function Documentation

template<int dim>
void Functions::CutOffFunctionBase< dim >::new_center ( const Point< dim > &  p  ) 

Move the center of the ball to new point p.

template<int dim>
void Functions::CutOffFunctionBase< dim >::new_radius ( const double  r  ) 

Set the radius of the ball to r.


Member Data Documentation

Value used in the constructor of this and derived classes to denote that no component is selected.

template<int dim>
Point<dim> Functions::CutOffFunctionBase< dim >::center [protected]

Center of the integration ball.

template<int dim>
double Functions::CutOffFunctionBase< dim >::radius [protected]

Radius of the ball.

template<int dim>
const unsigned int Functions::CutOffFunctionBase< dim >::selected [protected]

Component selected. If no_component, the function is the same in all components.


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

deal.II documentation generated on Mon Nov 23 22:58:19 2009 by doxygen 1.6.1