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

Inheritance diagram for Functions::FourierSineFunction< dim >:

Public Member Functions
	FourierSineFunction (const Tensor< 1, dim > &fourier_coefficients)

virtual double	value (const Point< dim > &p, const unsigned int component=0) 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

Public Member Functions inherited from Function< dim >
	Function (const unsigned int n_components=1, const time_type initial_time=0.0)

	Function (const Function &f)=default

virtual	~Function () override=0

Function &	operator= (const Function &f)

virtual void	vector_value (const Point< dim > &p, Vector< double > &values) const

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

virtual void	vector_value_list (const std::vector< Point< dim >> &points, std::vector< 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	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

virtual SymmetricTensor< 2, dim, double >	hessian (const Point< dim > &p, const unsigned int component=0) 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< numbers::NumberTraits< double >::real_type >
	FunctionTime (const numbers::NumberTraits< double >::real_type initial_time=numbers::NumberTraits< double >::real_type(0.0))

virtual	~FunctionTime ()=default

numbers::NumberTraits< double >::real_type	get_time () const

virtual void	set_time (const numbers::NumberTraits< double >::real_type new_time)

virtual void	advance_time (const numbers::NumberTraits< double >::real_type delta_t)

Public Member Functions inherited from Subscriptor
	Subscriptor ()

	Subscriptor (const Subscriptor &)

	Subscriptor (Subscriptor &&) noexcept

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&) noexcept

void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") 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)

Private Attributes
const Tensor< 1, dim >	fourier_coefficients

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< numbers::NumberTraits< double >::real_type >
using	time_type = numbers::NumberTraits< double >::real_type

Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (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::FourierSineFunction< dim >

Given a wavenumber vector generate a sine function. The wavenumber coefficient is given as a \(d\)-dimensional point \(k\) in Fourier space, and the function is then recovered as \(f(x) = \sin(\sum_i k_i x_i) = Im(\exp(i k.x))\).

The class has its name from the fact that it resembles one component of a Fourier sine decomposition.

Author: Wolfgang Bangerth, 2001

Definition at line 762 of file function_lib.h.

Constructor & Destructor Documentation

◆ FourierSineFunction()

template<int dim>

Functions::FourierSineFunction< dim >::FourierSineFunction ( const Tensor< 1, dim > & fourier_coefficients )

Constructor. Take the Fourier coefficients in each space direction as argument.

Definition at line 1972 of file function_lib.cc.

Member Function Documentation

◆ value()

template<int dim>

double Functions::FourierSineFunction< 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 1982 of file function_lib.cc.

◆ gradient()

template<int dim>

Tensor< 1, dim > Functions::FourierSineFunction< 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 1994 of file function_lib.cc.

◆ laplacian()

template<int dim>

double Functions::FourierSineFunction< 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 2006 of file function_lib.cc.

Member Data Documentation

◆ fourier_coefficients

template<int dim>

const Tensor<1, dim> Functions::FourierSineFunction< dim >::fourier_coefficients

private

Stored Fourier coefficients.

Definition at line 799 of file function_lib.h.

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

include/deal.II/base/function_lib.h
source/base/function_lib.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<int dim> class Functions::FourierSineFunction< dim >

Constructor & Destructor Documentation

◆ FourierSineFunction()

Member Function Documentation

◆ value()

◆ gradient()

◆ laplacian()

Member Data Documentation

◆ fourier_coefficients

template<int dim>
class Functions::FourierSineFunction< dim >