VectorFunctionFromScalarFunctionObject< dim, RangeNumberType > Class Template Reference

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

Inheritance diagram for VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >:

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

Public Member Functions
	VectorFunctionFromScalarFunctionObject (const std::function< RangeNumberType(const Point< dim > &)> &function_object, const unsigned int selected_component, const unsigned int n_components)
virtual RangeNumberType	value (const Point< dim > &p, const unsigned int component=0) const override
virtual void	vector_value (const Point< dim > &p, Vector< RangeNumberType > &values) const override
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 Tensor< 1, dim, RangeNumberType >	gradient (const Point< dim > &p, const unsigned int component=0) 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 SymmetricTensor< 2, dim, RangeNumberType >	hessian (const Point< dim > &p, const unsigned int component=0) 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
virtual std::size_t	memory_consumption () const
Number	get_time () const
virtual void	set_time (const Number new_time)
virtual void	advance_time (const Number delta_t)

Public Attributes
const unsigned int	n_components

Static Public Attributes
static constexpr unsigned int	dimension = dim

Private Attributes
const std::function< RangeNumberType(const Point< dim > &)>	function_object
const unsigned int	selected_component
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 dim, typename RangeNumberType = double>
class VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >

This class is similar to the ScalarFunctionFromFunctionObject class in that it allows for the easy conversion of a function object to something that satisfies the interface of the Function base class. The difference is that here, the given function object is still a scalar function (i.e. it has a single value at each space point) but that the Function object generated is vector valued. The number of vector components is specified in the constructor, where one also selects a single one of these vector components that should be filled by the passed object. The result is a vector Function object that returns zero in each component except the single selected one where it returns the value returned by the given as the first argument to the constructor.

Note

In the above discussion, note the difference between the (scalar) "function object" (i.e., a C++ object x that can be called as in x(p)) and the capitalized (vector valued) "Function object" (i.e., an object of a class that is derived from the Function base class).

To be more concrete, let us consider the following example:

RangeNumberType
one(const Point<2> &p)
{
  return 1.0;
}
 
VectorFunctionFromScalarFunctionObject<2, RangeNumberType>
  component_mask(&one, 1, 3);

Here, component_mask then represents a Function object that for every point returns the vector \((0, 1, 0)^T\), i.e. a mask function that could, for example, be passed to VectorTools::integrate_difference(). This effect can also be achieved using the ComponentSelectFunction class but is obviously easily extended to functions that are non-constant in their one component.

Definition at line 891 of file function.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 169 of file function.h.

Constructor & Destructor Documentation

VectorFunctionFromScalarFunctionObject()

template<int dim, typename RangeNumberType = double>

VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >::VectorFunctionFromScalarFunctionObject	(	const std::function< RangeNumberType(const Point< dim > &)> &	function_object,
		const unsigned int	selected_component,
		const unsigned int	n_components
	)

Given a function object that takes a Point and returns a RangeNumberType value, convert this into an object that matches the Function<dim> interface.

Parameters

function_object	The scalar function that will form one component of the resulting Function object.
n_components	The total number of vector components of the resulting Function object.
selected_component	The single component that should be filled by the first argument.

Member Function Documentation

value()

template<int dim, typename RangeNumberType = double>

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

overridevirtual

Return the value of the function at the given point. Returns the value the function given to the constructor produces for this point.

Reimplemented from Function< dim, RangeNumberType >.

vector_value()

template<int dim, typename RangeNumberType = double>

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

overridevirtual

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

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

Reimplemented from Function< dim, RangeNumberType >.

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.

gradient()

template<int dim, typename RangeNumberType = double>

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

virtualinherited

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

Reimplemented in Functions::SignedDistance::Plane< dim >, Functions::SignedDistance::Ellipsoid< dim >, Functions::CosineGradFunction< dim >, AutoDerivativeFunction< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::IdentityFunction< dim, RangeNumberType >, FunctionFromFunctionObjects< dim, RangeNumberType >, Functions::Bessel1< dim >, Functions::CSpline< dim >, Functions::SquareFunction< dim >, Functions::Q1WedgeFunction< dim >, Functions::PillowFunction< dim >, Functions::CosineFunction< dim >, Functions::ExpFunction< dim >, Functions::SlitSingularityFunction< dim >, Functions::JumpFunction< dim >, Functions::FourierCosineFunction< dim >, Functions::FourierSineFunction< dim >, Functions::FourierSineSum< dim >, Functions::FourierCosineSum< dim >, Functions::CutOffFunctionTensorProduct< dim >, Functions::CutOffFunctionC1< dim >, Functions::CutOffFunctionCinfty< dim >, Functions::Monomial< dim, Number >, Functions::InterpolatedTensorProductGridData< dim >, Functions::InterpolatedUniformGridData< dim >, Functions::Polynomial< dim >, Functions::Spherical< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::CoordinateRestriction< dim >, Functions::SignedDistance::Sphere< dim >, and NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >.

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 >, 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 >, and Functions::ConstantFunction< 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.

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 >, and Functions::ConstantFunction< 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.

Reimplemented in Functions::CosineGradFunction< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::CSpline< dim >, Functions::SquareFunction< dim >, Functions::Q1WedgeFunction< dim >, Functions::PillowFunction< dim >, Functions::CosineFunction< dim >, Functions::ExpFunction< dim >, Functions::SlitSingularityFunction< dim >, Functions::JumpFunction< dim >, Functions::FourierCosineFunction< dim >, Functions::FourierSineFunction< dim >, Functions::FourierSineSum< dim >, Functions::FourierCosineSum< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::ConstantFunction< dim, RangeNumberType >, and Functions::ConstantFunction< dim, double >.

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

hessian()

template<int dim, typename RangeNumberType = double>

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

virtualinherited

Compute the Hessian of a given component at point p, that is the gradient of the gradient of the function.

Reimplemented in Functions::SignedDistance::Plane< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::CSpline< dim >, Functions::CosineFunction< dim >, Functions::Spherical< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::CoordinateRestriction< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::SignedDistance::Sphere< dim >, and NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >.

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.

memory_consumption()

template<int dim, typename RangeNumberType = double>

virtual std::size_t Function< dim, RangeNumberType >::memory_consumption ( ) const

virtualinherited

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

This function is virtual and can be overloaded by derived classes.

Reimplemented in Functions::FlowFunction< dim >, Functions::FlowFunction< 2 >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, ComponentSelectFunction< dim, RangeNumberType >, Functions::CSpline< dim >, FunctionDerivative< dim >, Functions::JumpFunction< dim >, Functions::InterpolatedTensorProductGridData< dim >, Functions::InterpolatedUniformGridData< dim >, Functions::Polynomial< dim >, and Functions::Spherical< dim >.

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

function_object

template<int dim, typename RangeNumberType = double>

const std::function<RangeNumberType(const Point<dim> &)> VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >::function_object

private

The function object which we call when this class's value() or value_list() functions are called.

Definition at line 933 of file function.h.

selected_component

template<int dim, typename RangeNumberType = double>

const unsigned int VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >::selected_component

private

The vector component whose value is to be filled by the given scalar function.

Definition at line 939 of file function.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 159 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 164 of file 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/function.h