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 | Protected Attributes | List of all members
Functions::JumpFunction< dim > Class Template Reference

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

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

Public Member Functions

 JumpFunction (const Point< dim > &direction, const double steepness)
 
virtual double value (const Point< dim > &p, const unsigned int component=0) 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 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
 
std::size_t memory_consumption () 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)
 

Protected Attributes

const Point< dim > direction
 
const double steepness
 
double angle
 
double sine
 
double cosine
 

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::JumpFunction< dim >

A jump in x-direction transported into some direction.

If the advection is parallel to the y-axis, the function is -atan(sx), where s is the steepness parameter provided in the constructor.

For different advection directions, this function will be turned in the parameter space.

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

Author
: Guido Kanschat, 2000

Definition at line 531 of file function_lib.h.

Constructor & Destructor Documentation

template<int dim>
Functions::JumpFunction< dim >::JumpFunction ( const Point< dim > &  direction,
const double  steepness 
)

Constructor. Provide the advection direction here and the steepness of the slope.

Member Function Documentation

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

Function value at one point.

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

Function values at multiple points.

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

Gradient at one point.

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

Gradients at multiple points.

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

Laplacian of the function at one point.

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

Laplacian of the function at multiple points.

template<int dim>
std::size_t Functions::JumpFunction< dim >::memory_consumption ( ) const

Determine an estimate for the memory consumption (in bytes) of this object. Since sometimes the size of objects can not be determined exactly (for example: what is the memory consumption of an STL std::map type with a certain number of elements?), this is only an estimate. however often quite close to the true value.

Member Data Documentation

template<int dim>
const Point<dim> Functions::JumpFunction< dim >::direction
protected

Advection vector.

Definition at line 593 of file function_lib.h.

template<int dim>
const double Functions::JumpFunction< dim >::steepness
protected

Steepness (maximal derivative) of the slope.

Definition at line 598 of file function_lib.h.

template<int dim>
double Functions::JumpFunction< dim >::angle
protected

Advection angle.

Definition at line 603 of file function_lib.h.

template<int dim>
double Functions::JumpFunction< dim >::sine
protected

Sine of angle.

Definition at line 608 of file function_lib.h.

template<int dim>
double Functions::JumpFunction< dim >::cosine
protected

Cosine of angle.

Definition at line 613 of file function_lib.h.


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