Reference documentation for deal.II version Git 96dee1a3e7 2019-03-21 22:06:48 +0100
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | List of all members
Functions::CosineFunction< dim > Class Template Reference

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

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

Public Member Functions

 CosineFunction (const unsigned int n_components=1)
 
virtual double value (const Point< dim > &p, const unsigned int component=0) const override
 
virtual void value_list (const std::vector< Point< dim >> &points, std::vector< double > &values, const unsigned int component=0) const override
 
virtual void vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &values) const override
 
virtual Tensor< 1, dim > gradient (const Point< dim > &p, const unsigned int component=0) const override
 
virtual double laplacian (const Point< dim > &p, const unsigned int component=0) const override
 
virtual void laplacian_list (const std::vector< Point< dim >> &points, std::vector< double > &values, const unsigned int component=0) const override
 
virtual SymmetricTensor< 2, dim > hessian (const Point< dim > &p, const unsigned int component=0) const override
 
virtual void hessian_list (const std::vector< Point< dim >> &points, std::vector< SymmetricTensor< 2, dim >> &hessians, const unsigned int component=0) const override
 
- Public Member Functions inherited from Function< dim >
 Function (const unsigned int n_components=1, const time_type initial_time=0.0)
 
virtual ~Function () override=0
 
Functionoperator= (const Function &f)
 
virtual void vector_value (const Point< dim > &p, Vector< double > &values) const
 
virtual void vector_values (const std::vector< Point< dim >> &points, std::vector< std::vector< double >> &values) const
 
virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, double >> &gradients) const
 
virtual void gradient_list (const std::vector< Point< dim >> &points, std::vector< Tensor< 1, dim, double >> &gradients, const unsigned int component=0) const
 
virtual void vector_gradients (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, double >>> &gradients) const
 
virtual void vector_gradient_list (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, double >>> &gradients) const
 
virtual void vector_laplacian (const Point< dim > &p, Vector< double > &values) const
 
virtual void vector_laplacian_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &values) const
 
virtual void vector_hessian (const Point< dim > &p, std::vector< SymmetricTensor< 2, dim, double >> &values) const
 
virtual void hessian_list (const std::vector< Point< dim >> &points, std::vector< SymmetricTensor< 2, dim, double >> &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, 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 ()=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 &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
template<typename ConstCharStar = const char *>
std::enable_if< std::is_same< ConstCharStar, const char * >::value >::type subscribe (std::atomic< bool > *const validity, ConstCharStar identifier=nullptr) const
 
void subscribe (std::atomic< bool > *const validity, const char *&&identifier) const =delete
 
void unsubscribe (std::atomic< bool > *const validity, const char *identifier=nullptr) const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Additional Inherited Members

- Public Types inherited from Function< dim >
using time_type = typename FunctionTime< typename numbers::NumberTraits< double >::real_type >::time_type
 
- Public Types inherited from FunctionTime< Number >
using time_type = Number
 
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
- 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::CosineFunction< dim >

Cosine-shaped pillow function. This is another function with zero boundary values on \([-1,1]^d\). In the interior it is the product of \(\cos(\pi/2 x_i)\).

Author
Guido Kanschat, 1999

Definition at line 222 of file function_lib.h.

Constructor & Destructor Documentation

◆ CosineFunction()

template<int dim>
Functions::CosineFunction< dim >::CosineFunction ( const unsigned int  n_components = 1)

Constructor which allows to optionally generate a vector valued cosine function with the same value in each component.

Definition at line 425 of file function_lib.cc.

Member Function Documentation

◆ value()

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

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

Definition at line 433 of file function_lib.cc.

◆ value_list()

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

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

Definition at line 454 of file function_lib.cc.

◆ vector_value_list()

template<int dim>
void Functions::CosineFunction< dim >::vector_value_list ( const std::vector< Point< dim >> &  points,
std::vector< Vector< double >> &  values 
) const
overridevirtual

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

Definition at line 468 of file function_lib.cc.

◆ gradient()

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

Return the gradient of the specified component of the function at the given point.

Reimplemented from Function< dim >.

Definition at line 523 of file function_lib.cc.

◆ laplacian()

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

Compute the Laplacian of a given component at point p.

Reimplemented from Function< dim >.

Definition at line 486 of file function_lib.cc.

◆ laplacian_list()

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

Compute the Laplacian of one component at a set of points.

Reimplemented from Function< dim >.

Definition at line 510 of file function_lib.cc.

◆ hessian()

template<int dim>
SymmetricTensor< 2, dim > Functions::CosineFunction< dim >::hessian ( const Point< dim > &  p,
const unsigned int  component = 0 
) const
overridevirtual

Second derivatives at a single point.

Reimplemented from Function< dim >.

Definition at line 598 of file function_lib.cc.

◆ hessian_list()

template<int dim>
void Functions::CosineFunction< dim >::hessian_list ( const std::vector< Point< dim >> &  points,
std::vector< SymmetricTensor< 2, dim >> &  hessians,
const unsigned int  component = 0 
) const
overridevirtual

Second derivatives at multiple points.

Definition at line 652 of file function_lib.cc.


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