Reference documentation for deal.II version Git 05e4468 2017-09-21 10:18:23 +0200
Public Member Functions | Protected Attributes | List of all members
Functions::ConstantFunction< dim, Number > Class Template Reference

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

Inheritance diagram for Functions::ConstantFunction< dim, Number >:
[legend]

Public Member Functions

 ConstantFunction (const Number value, const unsigned int n_components=1)
 
 ConstantFunction (const std::vector< Number > &values)
 
 ConstantFunction (const Vector< Number > &values)
 
 ConstantFunction (const Number *begin_ptr, const unsigned int n_components)
 
virtual Number value (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_value (const Point< dim > &p, Vector< Number > &return_value) const
 
virtual void value_list (const std::vector< Point< dim > > &points, std::vector< Number > &return_values, const unsigned int component=0) const
 
virtual void vector_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< Number > > &return_values) const
 
virtual Tensor< 1, dim, Number > gradient (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, Number > > &gradients) const
 
virtual void gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim, Number > > &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, Number > > > &gradients) const
 
- Public Member Functions inherited from Function< dim, Number >
 Function (const unsigned int n_components=1, const Number initial_time=0.0)
 
virtual ~Function ()=0
 
Functionoperator= (const Function &f)
 
virtual void vector_values (const std::vector< Point< dim > > &points, std::vector< std::vector< Number > > &values) const
 
virtual void vector_gradients (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, Number > > > &gradients) const
 
virtual Number laplacian (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_laplacian (const Point< dim > &p, Vector< Number > &values) const
 
virtual void laplacian_list (const std::vector< Point< dim > > &points, std::vector< Number > &values, const unsigned int component=0) const
 
virtual void vector_laplacian_list (const std::vector< Point< dim > > &points, std::vector< Vector< Number > > &values) const
 
virtual SymmetricTensor< 2, dim, Number > hessian (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_hessian (const Point< dim > &p, std::vector< SymmetricTensor< 2, dim, Number > > &values) const
 
virtual void hessian_list (const std::vector< Point< dim > > &points, std::vector< SymmetricTensor< 2, dim, Number > > &values, const unsigned int component=0) const
 
virtual void vector_hessian_list (const std::vector< Point< dim > > &points, std::vector< std::vector< SymmetricTensor< 2, dim, Number > > > &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 ()=default
 
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 &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=nullptr) const
 
void unsubscribe (const char *identifier=nullptr) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Protected Attributes

std::vector< Number > function_value_vector
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *arg2)
 
- Public Attributes inherited from Function< dim, Number >
const unsigned int n_components
 
- Static Public Attributes inherited from Function< dim, Number >
static const unsigned int dimension = dim
 

Detailed Description

template<int dim, typename Number = double>
class Functions::ConstantFunction< dim, Number >

Provide a function which always returns the constant values handed to the constructor.

Author
Wolfgang Bangerth, 1998, 1999, Lei Qiao, 2015

Definition at line 361 of file function.h.

Constructor & Destructor Documentation

template<int dim, typename Number = double>
Functions::ConstantFunction< dim, Number >::ConstantFunction ( const Number  value,
const unsigned int  n_components = 1 
)

Constructor; set values of all components to the provided one. The default number of components is one.

template<int dim, typename Number = double>
Functions::ConstantFunction< dim, Number >::ConstantFunction ( const std::vector< Number > &  values)

Constructor; takes an std::vector<Number> object as an argument. The number of components is determined by values.size().

template<int dim, typename Number = double>
Functions::ConstantFunction< dim, Number >::ConstantFunction ( const Vector< Number > &  values)

Constructor; takes an Vector<Number> object as an argument. The number of components is determined by values.size().

template<int dim, typename Number = double>
Functions::ConstantFunction< dim, Number >::ConstantFunction ( const Number *  begin_ptr,
const unsigned int  n_components 
)

Constructor; uses whatever stores in [begin_ptr, begin_ptr+n_components) to initialize a new object.

Member Function Documentation

template<int dim, typename Number = double>
virtual Number Functions::ConstantFunction< dim, Number >::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.

Reimplemented from Function< dim, Number >.

template<int dim, typename Number = double>
virtual void Functions::ConstantFunction< dim, Number >::vector_value ( const Point< dim > &  p,
Vector< Number > &  values 
) const
virtual

Return all components of a vector-valued function at a given point.

values shall have the right size beforehand, i.e. n_components.

The default implementation will call value() for each component.

Reimplemented from Function< dim, Number >.

Reimplemented in ComponentSelectFunction< dim, Number >.

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

Set values to the point values of the specified component of the function at the points. It is assumed that values already has the right size, i.e. the same size as the points array.

By default, this function repeatedly calls value() for each point separately, to fill the output array.

Reimplemented from Function< dim, Number >.

template<int dim, typename Number = double>
virtual void Functions::ConstantFunction< dim, Number >::vector_value_list ( const std::vector< Point< dim > > &  points,
std::vector< Vector< Number > > &  values 
) const
virtual

Set values to the point values of the function at the points. It is assumed that values already has the right size, i.e. the same size as the points array, and that all elements be vectors with the same number of components as this function has.

By default, this function repeatedly calls vector_value() for each point separately, to fill the output array.

Reimplemented from Function< dim, Number >.

Reimplemented in ComponentSelectFunction< dim, Number >.

template<int dim, typename Number = double>
virtual Tensor<1,dim, Number> Functions::ConstantFunction< dim, Number >::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.

Reimplemented from Function< dim, Number >.

template<int dim, typename Number = double>
virtual void Functions::ConstantFunction< dim, Number >::vector_gradient ( const Point< dim > &  p,
std::vector< Tensor< 1, dim, Number > > &  gradients 
) const
virtual

Return the gradient of all components of the function at the given point.

Reimplemented from Function< dim, Number >.

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

Set gradients to the gradients of the specified component of the function at the points. It is assumed that gradients already has the right size, i.e. the same size as the points array.

Reimplemented from Function< dim, Number >.

template<int dim, typename Number = double>
virtual void Functions::ConstantFunction< dim, Number >::vector_gradient_list ( const std::vector< Point< dim > > &  points,
std::vector< std::vector< Tensor< 1, dim, Number > > > &  gradients 
) const
virtual

Set gradients to the gradients of the function at the points, for all components. It is assumed that gradients already has the right size, i.e. the same size as the points array.

The outer loop over gradients is over the points in the list, the inner loop over the different components of the function.

Reimplemented from Function< dim, Number >.

Member Data Documentation

template<int dim, typename Number = double>
std::vector<Number> Functions::ConstantFunction< dim, Number >::function_value_vector
protected

Store the constant function value vector.

Definition at line 421 of file function.h.


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