Reference documentation for deal.II version Git 283ce71 2014-12-19 22:22:25 +0100
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
Functions::CutOffFunctionBase< dim > Class Template Reference

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

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

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)
 
- 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)
 

Static Public Attributes

static const unsigned int no_component = numbers::invalid_unsigned_int
 
- Static Public Attributes inherited from Function< dim >
static const unsigned int dimension
 

Protected Attributes

Point< dim > center
 
double radius
 
const unsigned int selected
 

Additional Inherited Members

- Public Attributes inherited from Function< dim >
const unsigned int n_components
 

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

Definition at line 833 of file function_lib.h.

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

template<int dim>
const unsigned int Functions::CutOffFunctionBase< dim >::no_component = numbers::invalid_unsigned_int
static

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

Definition at line 840 of file function_lib.h.

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

Center of the integration ball.

Definition at line 867 of file function_lib.h.

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

Radius of the ball.

Definition at line 872 of file function_lib.h.

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

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

Definition at line 878 of file function_lib.h.


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