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

Inheritance diagram for ConstantTensorFunction< rank, dim, Number >:

Public Types
using	time_type = typename TensorFunction< rank, dim, Number >::time_type

using	value_type = Tensor< rank, dim, Number >

using	gradient_type = Tensor< rank+1, dim, Number >

Public Member Functions
	ConstantTensorFunction (const ::Tensor< rank, dim, Number > &value, const time_type initial_time=0.0)

virtual	~ConstantTensorFunction () override=default

virtual typename::TensorFunction< rank, dim, Number >::value_type	value (const Point< dim > &p) const override

virtual void	value_list (const std::vector< Point< dim > > &points, std::vector< typename ::TensorFunction< rank, dim, Number >::value_type > &values) const override

virtual typename::TensorFunction< rank, dim, Number >::gradient_type	gradient (const Point< dim > &p) const override

virtual void	gradient_list (const std::vector< Point< dim > > &points, std::vector< typename ::TensorFunction< rank, dim, Number >::gradient_type > &gradients) const override

virtual void	value_list (const std::vector< Point< dim > > &points, std::vector< value_type > &values) const

virtual void	gradient_list (const std::vector< Point< dim > > &points, std::vector< gradient_type > &gradients) const

Number	get_time () const

virtual void	set_time (const Number new_time)

virtual void	advance_time (const Number delta_t)

Private Attributes
const ::Tensor< rank, dim, Number >	_value

Number	time

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
std::atomic< unsigned int >	counter

std::map< std::string, unsigned int >	counter_map

std::vector< std::atomic< bool > * >	validity_pointers

const std::type_info *	object_info

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)

using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

static std::mutex	mutex

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

void	check_no_subscribers () const noexcept

Detailed Description

template<int rank, int dim, typename Number = double>
class ConstantTensorFunction< rank, dim, Number >

Provide a tensor valued function which always returns a constant tensor value. Obviously, all derivates of this function are zero.

Definition at line 130 of file tensor_function.h.

Member Typedef Documentation

◆ time_type

template<int rank, int dim, typename Number = double>

using ConstantTensorFunction< rank, dim, Number >::time_type = typename TensorFunction<rank, dim, Number>::time_type

The scalar-valued real type used for representing time.

Definition at line 136 of file tensor_function.h.

◆ value_type

template<int rank, int dim, typename Number = double>

using TensorFunction< rank, dim, Number >::value_type = Tensor<rank, dim, Number>

inherited

Alias for the return types of the value function.

Definition at line 64 of file tensor_function.h.

◆ gradient_type

template<int rank, int dim, typename Number = double>

using TensorFunction< rank, dim, Number >::gradient_type = Tensor<rank + 1, dim, Number>

inherited

Alias for the return types of the gradient functions.

Definition at line 69 of file tensor_function.h.

Constructor & Destructor Documentation

◆ ConstantTensorFunction()

template<int rank, int dim, typename Number = double>

ConstantTensorFunction< rank, dim, Number >::ConstantTensorFunction	(	const ::Tensor< rank, dim, Number > &	value,
		const time_type	initial_time = `0.0`
	)

Constructor; takes the constant tensor value as an argument. The reference value is copied internally.

An initial value for the time variable may be specified, otherwise it defaults to zero.

◆ ~ConstantTensorFunction()

template<int rank, int dim, typename Number = double>

virtual ConstantTensorFunction< rank, dim, Number >::~ConstantTensorFunction ( )

overridevirtualdefault

Member Function Documentation

◆ value()

template<int rank, int dim, typename Number = double>

virtual typename::TensorFunction< rank, dim, Number >::value_type ConstantTensorFunction< rank, dim, Number >::value ( const Point< dim > & p ) const

overridevirtual

Return the value of the function at the given point.

Reimplemented from TensorFunction< rank, dim, Number >.

◆ value_list() [1/2]

template<int rank, int dim, typename Number = double>

virtual void ConstantTensorFunction< rank, dim, Number >::value_list	(	const std::vector< Point< dim > > &	points,
		std::vector< typename ::TensorFunction< rank, dim, Number >::value_type > &	values
	)		const

overridevirtual

◆ gradient()

template<int rank, int dim, typename Number = double>

virtual typename::TensorFunction< rank, dim, Number >::gradient_type ConstantTensorFunction< rank, dim, Number >::gradient ( const Point< dim > & p ) const

overridevirtual

Return the gradient of the function at the given point.

Reimplemented from TensorFunction< rank, dim, Number >.

◆ gradient_list() [1/2]

template<int rank, int dim, typename Number = double>

virtual void ConstantTensorFunction< rank, dim, Number >::gradient_list	(	const std::vector< Point< dim > > &	points,
		std::vector< typename ::TensorFunction< rank, dim, Number >::gradient_type > &	gradients
	)		const

overridevirtual

◆ value_list() [2/2]

template<int rank, int dim, typename Number = double>

virtual void TensorFunction< rank, dim, Number >::value_list	(	const std::vector< Point< dim > > &	points,
		std::vector< value_type > &	values
	)		const

virtualinherited

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.

Reimplemented in TensorFunctionParser< rank, dim, Number >.

◆ gradient_list() [2/2]

template<int rank, int dim, typename Number = double>

virtual void TensorFunction< rank, dim, Number >::gradient_list	(	const std::vector< Point< dim > > &	points,
		std::vector< gradient_type > &	gradients
	)		const

virtualinherited

Set gradients to the gradients 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.

◆ get_time()

template<typename Number = double>

Number FunctionTime< Number >::get_time ( ) const

inherited

Return the value of the time variable.

◆ set_time()

template<typename Number = double>

virtual void FunctionTime< Number >::set_time ( const Number new_time )

virtualinherited

Set the time to new_time, overwriting the old value.

◆ advance_time()

template<typename Number = double>

virtual void FunctionTime< Number >::advance_time ( const Number delta_t )

virtualinherited

Advance the time by the given time step delta_t.

Member Data Documentation

◆ _value

template<int rank, int dim, typename Number = double>

const ::Tensor<rank, dim, Number> ConstantTensorFunction< rank, dim, Number >::_value

private

Definition at line 170 of file tensor_function.h.

◆ time

template<typename Number = double>

Number FunctionTime< Number >::time

privateinherited

Store the present time.

Definition at line 113 of file function_time.h.

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

include/deal.II/base/tensor_function.h

Public Types

Public Member Functions

Private Attributes

Subscriptor functionality

Detailed Description

Member Typedef Documentation

◆ time_type

◆ value_type

◆ gradient_type

Constructor & Destructor Documentation

◆ ConstantTensorFunction()

◆ ~ConstantTensorFunction()

Member Function Documentation

◆ value()

◆ value_list() [1/2]

◆ gradient()

◆ gradient_list() [1/2]

◆ value_list() [2/2]

◆ gradient_list() [2/2]

◆ get_time()

◆ set_time()

◆ advance_time()

Member Data Documentation

◆ _value

◆ time