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

Inheritance diagram for Functions::Spherical< dim >:

[legend]

Public Types
using	time_type = typename FunctionTime< typename numbers::NumberTraits< RangeNumberType >::real_type >::time_type

Public Member Functions
	Spherical (const Point< dim > &center=Point< dim >(), const unsigned int n_components=1)

virtual double	value (const Point< dim > &point, const unsigned int component=0) const override

virtual Tensor< 1, dim >	gradient (const Point< dim > &p, const unsigned int component=0) const override

virtual SymmetricTensor< 2, dim >	hessian (const Point< dim > &p, const unsigned int component=0) const override

virtual std::size_t	memory_consumption () const override

Tensor< 1, 3 >	gradient (const Point< 3 > &p_, const unsigned int component) const

SymmetricTensor< 2, 3 >	hessian (const Point< 3 > &p_, const unsigned int component) const

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

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

virtual void	vector_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< RangeNumberType > > &values) const

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

virtual void	vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, RangeNumberType > > &gradients) const

virtual void	gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim, RangeNumberType > > &gradients, const unsigned int component=0) const

virtual void	vector_gradients (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) const

virtual void	vector_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &gradients) const

virtual RangeNumberType	laplacian (const Point< dim > &p, const unsigned int component=0) const

virtual void	vector_laplacian (const Point< dim > &p, Vector< RangeNumberType > &values) const

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

virtual void	vector_laplacian_list (const std::vector< Point< dim > > &points, std::vector< Vector< RangeNumberType > > &values) const

virtual void	vector_hessian (const Point< dim > &p, std::vector< SymmetricTensor< 2, dim, RangeNumberType > > &values) const

virtual void	hessian_list (const std::vector< Point< dim > > &points, std::vector< SymmetricTensor< 2, dim, RangeNumberType > > &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, RangeNumberType > > > &values) const

Number	get_time () const

virtual void	set_time (const Number new_time)

virtual void	advance_time (const Number delta_t)

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer class.
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

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

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

Public Attributes
const unsigned int	n_components

Static Public Attributes
static constexpr unsigned int	dimension = dim

Private Types
using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
virtual double	svalue (const std::array< double, dim > &sp, const unsigned int component) const

virtual std::array< double, dim >	sgradient (const std::array< double, dim > &sp, const unsigned int component) const

virtual std::array< double, 6 >	shessian (const std::array< double, dim > &sp, const unsigned int component) const

void	check_no_subscribers () const noexcept

Private Attributes
const Tensor< 1, dim >	coordinate_system_offset

Number	time

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

Static Private Attributes
static std::mutex	mutex

Detailed Description

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

An abstract base class for a scalar-valued function \(f=f(r,\theta,\phi)\) defined in spherical coordinates. This class wraps transformation of values, gradients and hessians from spherical coordinates to the Cartesian coordinate system used by the Function base class. Therefore derived classes only need to implement those functions in spherical coordinates (specifically svalue(), sgradient() and shessian() ). The convention for angles is the same as in GeometricUtilities::Coordinates.

Note: This function is currently only implemented for dim==3 .

Definition at line 43 of file function_spherical.h.

Member Typedef Documentation

◆ time_type

template<int dim, typename RangeNumberType = double>

using Function< dim, RangeNumberType >::time_type = typename FunctionTime< typename numbers::NumberTraits<RangeNumberType>::real_type>::time_type

inherited

The scalar-valued real type used for representing time.

Definition at line 168 of file function.h.

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 238 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 243 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ Spherical()

template<int dim>

Functions::Spherical< dim >::Spherical	(	const Point< dim > &	center = `Point<dim>()`,
		const unsigned int	n_components = `1`
	)

Constructor which should be provided with center defining the origin of the coordinate system.

Note that components of this function are treated as entirely separate quantities – not as the components of a vector that will be re-interpreted in a different coordinate system.

Definition at line 157 of file function_spherical.cc.

Member Function Documentation

◆ value()

template<int dim>

double Functions::Spherical< dim >::value	(	const Point< dim > &	point,
		const unsigned int	component = `0`
	)		const

overridevirtual

Return the value of the function at the given point.

This function converts the given point to spherical coordinates, calls svalue() with it, and returns the result.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 169 of file function_spherical.cc.

◆ gradient() [1/2]

template<int dim>

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

overridevirtual

Return the gradient with respect to the Cartesian coordinates at point p.

This function converts the given point to spherical coordinates, calls sgradient() with it, and converts the result into Cartesian coordinates.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 182 of file function_spherical.cc.

◆ hessian() [1/2]

template<int dim>

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

overridevirtual

Return the Hessian with respect to the Cartesian coordinates at point p.

This function converts the given point to spherical coordinates, calls sgradient and shessian() with it, and converts the result into Cartesian coordinates.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 238 of file function_spherical.cc.

◆ memory_consumption()

template<int dim>

std::size_t Functions::Spherical< dim >::memory_consumption ( ) const

overridevirtual

Return an estimate for the memory consumption, in bytes, of this object.

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 309 of file function_spherical.cc.

◆ svalue()

template<int dim>

double Functions::Spherical< dim >::svalue	(	const std::array< double, dim > &	sp,
		const unsigned int	component
	)		const

privatevirtual

Return the value at point sp. Here, sp is provided in spherical coordinates.

Definition at line 318 of file function_spherical.cc.

◆ sgradient()

template<int dim>

std::array< double, dim > Functions::Spherical< dim >::sgradient	(	const std::array< double, dim > &	sp,
		const unsigned int	component
	)		const

privatevirtual

Return the gradient in spherical coordinates.

The returned object should contain derivatives in the following order: \(\{ f_{,r},\, f_{,\theta},\, f_{,\phi}\}\).

Definition at line 329 of file function_spherical.cc.

◆ shessian()

template<int dim>

std::array< double, 6 > Functions::Spherical< dim >::shessian	(	const std::array< double, dim > &	sp,
		const unsigned int	component
	)		const

privatevirtual

Return the Hessian in spherical coordinates.

The returned object should contain derivatives in the following order: \(\{ f_{,rr},\, f_{,\theta\theta},\, f_{,\phi\phi},\, f_{,r\theta},\, f_{,r\phi},\, f_{,\theta\phi}\}\).

Definition at line 340 of file function_spherical.cc.

◆ gradient() [2/2]

Tensor< 1, 3 > Functions::Spherical< 3 >::gradient	(	const Point< 3 > &	p_,
		const unsigned int	component
	)		const

Definition at line 194 of file function_spherical.cc.

◆ hessian() [2/2]

SymmetricTensor< 2, 3 > Functions::Spherical< 3 >::hessian	(	const Point< 3 > &	p_,
		const unsigned int	component
	)		const

Definition at line 249 of file function_spherical.cc.

◆ vector_value()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_value	(	const Point< dim > &	p,
		Vector< RangeNumberType > &	values
	)		const

virtualinherited

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 in Functions::ConstantFunction< dim, RangeNumberType >, ComponentSelectFunction< dim, RangeNumberType >, VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, Functions::IncrementalFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ value_list()

template<int dim, typename RangeNumberType = double>

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

virtualinherited

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 in Functions::ConstantFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ vector_value_list()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_value_list	(	const std::vector< Point< dim > > &	points,
		std::vector< Vector< RangeNumberType > > &	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, 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 in Functions::ConstantFunction< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, ComponentSelectFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ vector_values()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_values	(	const std::vector< Point< dim > > &	points,
		std::vector< std::vector< RangeNumberType > > &	values
	)		const

virtualinherited

For each component of the function, fill a vector of values, one for each point.

The default implementation of this function in Function calls value_list() for each component. In order to improve performance, this can be reimplemented in derived classes to speed up performance.

◆ vector_gradient()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_gradient	(	const Point< dim > &	p,
		std::vector< Tensor< 1, dim, RangeNumberType > > &	gradients
	)		const

virtualinherited

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

Reimplemented in Functions::ConstantFunction< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ gradient_list()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::gradient_list	(	const std::vector< Point< dim > > &	points,
		std::vector< Tensor< 1, dim, RangeNumberType > > &	gradients,
		const unsigned int	component = `0`
	)		const

virtualinherited

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 in Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::ConstantFunction< dim, RangeNumberType >, and VectorFunctionFromTensorFunction< dim, RangeNumberType >.

◆ vector_gradients()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_gradients	(	const std::vector< Point< dim > > &	points,
		std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &	gradients
	)		const

virtualinherited

For each component of the function, fill a vector of gradient values, one for each point.

The default implementation of this function in Function calls value_list() for each component. In order to improve performance, this can be reimplemented in derived classes to speed up performance.

Reimplemented in VectorFunctionFromTensorFunction< dim, RangeNumberType >.

◆ vector_gradient_list()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_gradient_list	(	const std::vector< Point< dim > > &	points,
		std::vector< std::vector< Tensor< 1, dim, RangeNumberType > > > &	gradients
	)		const

virtualinherited

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 in Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::ConstantFunction< dim, RangeNumberType >, and VectorFunctionFromTensorFunction< dim, RangeNumberType >.

◆ laplacian()

template<int dim, typename RangeNumberType = double>

virtual RangeNumberType Function< dim, RangeNumberType >::laplacian	(	const Point< dim > &	p,
		const unsigned int	component = `0`
	)		const

virtualinherited

Compute the Laplacian of a given component at point p.

◆ vector_laplacian()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_laplacian	(	const Point< dim > &	p,
		Vector< RangeNumberType > &	values
	)		const

virtualinherited

Compute the Laplacian of all components at point p and store them in values.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ laplacian_list()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::laplacian_list	(	const std::vector< Point< dim > > &	points,
		std::vector< RangeNumberType > &	values,
		const unsigned int	component = `0`
	)		const

virtualinherited

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

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ vector_laplacian_list()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_laplacian_list	(	const std::vector< Point< dim > > &	points,
		std::vector< Vector< RangeNumberType > > &	values
	)		const

virtualinherited

Compute the Laplacians of all components at a set of points.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ vector_hessian()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_hessian	(	const Point< dim > &	p,
		std::vector< SymmetricTensor< 2, dim, RangeNumberType > > &	values
	)		const

virtualinherited

Compute the Hessian of all components at point p and store them in values.

◆ hessian_list()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::hessian_list	(	const std::vector< Point< dim > > &	points,
		std::vector< SymmetricTensor< 2, dim, RangeNumberType > > &	values,
		const unsigned int	component = `0`
	)		const

virtualinherited

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

◆ vector_hessian_list()

template<int dim, typename RangeNumberType = double>

virtual void Function< dim, RangeNumberType >::vector_hessian_list	(	const std::vector< Point< dim > > &	points,
		std::vector< std::vector< SymmetricTensor< 2, dim, RangeNumberType > > > &	values
	)		const

virtualinherited

Compute the Hessians of all components at a set of points.

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

◆ subscribe()

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

inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 131 of file enable_observer_pointer.cc.

◆ unsubscribe()

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

inherited

Unsubscribes a user from the object.

Note: The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 151 of file enable_observer_pointer.cc.

◆ n_subscriptions()

unsigned int EnableObserverPointer::n_subscriptions ( ) const

inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 322 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 339 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >

void EnableObserverPointer::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 331 of file enable_observer_pointer.h.

◆ check_no_subscribers()

void EnableObserverPointer::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note: Since this function is just a consistency check it does nothing in release mode.; If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file enable_observer_pointer.cc.

Member Data Documentation

◆ coordinate_system_offset

template<int dim>

const Tensor<1, dim> Functions::Spherical< dim >::coordinate_system_offset

private

A vector from the origin to the center of spherical coordinate system.

Definition at line 128 of file function_spherical.h.

◆ dimension

template<int dim, typename RangeNumberType = double>

constexpr unsigned int Function< dim, RangeNumberType >::dimension = dim

staticconstexprinherited

Export the value of the template parameter as a static member constant. Sometimes useful for some expression template programming.

Definition at line 158 of file function.h.

◆ n_components

template<int dim, typename RangeNumberType = double>

const unsigned int Function< dim, RangeNumberType >::n_components

inherited

Number of vector components.

Definition at line 163 of file function.h.

◆ time

template<typename Number = double>

Number FunctionTime< Number >::time

privateinherited

Store the present time.

Definition at line 112 of file function_time.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 227 of file enable_observer_pointer.h.

◆ counter_map

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

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 233 of file enable_observer_pointer.h.

◆ validity_pointers

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

mutableprivateinherited

In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.

Definition at line 249 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 257 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::mutex

staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 280 of file enable_observer_pointer.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ time_type

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ Spherical()

Member Function Documentation

◆ value()

◆ gradient() [1/2]

◆ hessian() [1/2]

◆ memory_consumption()

◆ svalue()

◆ sgradient()

◆ shessian()

◆ gradient() [2/2]

◆ hessian() [2/2]

◆ vector_value()

◆ value_list()

◆ vector_value_list()

◆ vector_values()

◆ vector_gradient()

◆ gradient_list()

◆ vector_gradients()

◆ vector_gradient_list()

◆ laplacian()

◆ vector_laplacian()

◆ laplacian_list()

◆ vector_laplacian_list()

◆ vector_hessian()

◆ hessian_list()

◆ vector_hessian_list()

◆ get_time()

◆ set_time()

◆ advance_time()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ coordinate_system_offset

◆ dimension

◆ n_components

◆ time

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex