 |
Reference documentation for deal.II version 8.1.0
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
|
Reference documentation for deal.II version 8.1.0
|
#include <function.h>
Public Member Functions | |
| ComponentSelectFunction (const unsigned int selected, const double value, const unsigned int n_components) | |
| ComponentSelectFunction (const unsigned int selected, const unsigned int n_components) | |
| ComponentSelectFunction (const std::pair< unsigned int, unsigned int > &selected, const unsigned int n_components) | |
| virtual void | vector_value (const Point< dim > &p, Vector< double > &return_value) const |
| virtual void | vector_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< double > > &values) const |
| std::size_t | memory_consumption () const |
 Public Member Functions inherited from ConstantFunction< dim > | |
| ConstantFunction (const double value, const unsigned int n_components=1) | |
| virtual | ~ConstantFunction () |
| virtual double | value (const Point< dim > &p, const unsigned int component) const |
| virtual void | value_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 ZeroFunction< dim > | |
| ZeroFunction (const unsigned int n_components=1) | |
| virtual | ~ZeroFunction () |
| virtual Tensor< 1, dim > | gradient (const Point< dim > &p, const unsigned int component=0) const |
| virtual void | vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim > > &gradients) const |
| virtual void | gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim > > &gradients, const unsigned int component=0) const |
| virtual void | vector_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim > > > &gradients) const |
| Public Member Functions inherited from Function< dim > | |
| Function (const unsigned int n_components=1, const double initial_time=0.0) | |
| virtual | ~Function ()=0 |
| Function & | operator= (const Function &f) |
| virtual void | vector_values (const std::vector< Point< dim > > &points, std::vector< std::vector< double > > &values) const |
| virtual void | vector_gradients (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=0) 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 () |
| Subscriptor & | operator= (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 std::pair< unsigned int, unsigned int > | selected_components |
| Protected Attributes inherited from ConstantFunction< dim > | |
| const double | function_value |
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 |
This is a constant vector-valued function, in which one or more components of the vector have a constant value and all other components are zero. It is especially useful as a weight function for VectorTools::integrate_difference, where it allows to integrate only one or a few vector components, rather than the entire vector-valued solution. In other words, it acts as a component mask with a single component selected (see the the glossary entryon component masks"). See the @ref step_20 "step-20" tutorial program for a detailed explanation and a use case.
Definition at line 447 of file function.h.
| ComponentSelectFunction< dim >::ComponentSelectFunction | ( | const unsigned int | selected, |
| const double | value, | ||
| const unsigned int | n_components | ||
| ) |
Constructor if only a single component shall be non-zero. Arguments denote the component selected, the value for that component and the total number of vector components.
| ComponentSelectFunction< dim >::ComponentSelectFunction | ( | const unsigned int | selected, |
| const unsigned int | n_components | ||
| ) |
Constructor. As before, but the value for the selected component is assumed to be one. In essence, this function then works as a mask.
| ComponentSelectFunction< dim >::ComponentSelectFunction | ( | const std::pair< unsigned int, unsigned int > & | selected, |
| const unsigned int | n_components | ||
| ) |
Constructor if multiple components shall have non-zero, unit values (i.e. this should be a mask for multiple components). The first argument denotes a half-open interval of components (for example std::pair(0,dim) for the first dim components), and the second argument is the total number of vector components.
|
virtual |
Return the value of the function at the given point for all components.
Reimplemented from ConstantFunction< dim >.
|
virtual |
Set values to the point values of the function at the points, for all components. It is assumed that values already has the right size, i.e. the same size as the points array.
Reimplemented from ConstantFunction< dim >.
| std::size_t ComponentSelectFunction< 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.
|
protected |
Half-open interval of the indices of selected components.
Definition at line 505 of file function.h.
1.8.6