aspect::Utilities::VectorFunctionFromVelocityFunctionObject< dim > Class Template Reference

Inheritance diagram for aspect::Utilities::VectorFunctionFromVelocityFunctionObject< dim >:

Public Member Functions
	VectorFunctionFromVelocityFunctionObject (const unsigned int n_components, const std::function< Tensor< 1, dim >(const Point< dim > &)> &function_object)
Public Member Functions inherited from aspect::VectorFunctionFromTensorFunctionObject< dim, RangeNumberType >
	VectorFunctionFromTensorFunctionObject (const std::function< Tensor< 1, dim, RangeNumberType >(const Point< dim > &)> &tensor_function_object, const unsigned int selected_component=0, const unsigned int n_components=dim)
virtual	~VectorFunctionFromTensorFunctionObject () override=default
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	vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< RangeNumberType >> &value_list) const override
Public Member Functions inherited from Function< dim, double >
	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	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)
void	serialize (Archive &ar, const unsigned int version)
unsigned int	n_subscriptions () const
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
Public Member Functions inherited from FunctionTime< typename Number >
	FunctionTime (const Number initial_time=Number(0.0))
virtual	~FunctionTime ()=default
Number	get_time () const
Public Member Functions inherited from EnableObserverPointer
	EnableObserverPointer ()
	EnableObserverPointer (const EnableObserverPointer &)
	EnableObserverPointer (EnableObserverPointer &&) noexcept
virtual	~EnableObserverPointer ()
EnableObserverPointer &	operator= (const EnableObserverPointer &)
EnableObserverPointer &	operator= (EnableObserverPointer &&) noexcept
void	serialize (Archive &ar, const unsigned int version)
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const
unsigned int	n_subscriptions () const
void	list_subscribers (StreamType &stream) const
void	list_subscribers () const

Additional Inherited Members
Public Types inherited from Function< dim, double >
typedef typename FunctionTime< typename numbers::NumberTraits< RangeNumberType >::real_type >::time_type	time_type
Public Types inherited from FunctionTime< typename Number >
typedef Number	time_type
Static Public Member Functions inherited from Function< dim, double >
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
Static Public Member Functions inherited from EnableObserverPointer
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, double >
const unsigned int	n_components
Static Public Attributes inherited from Function< dim, double >
static constexpr unsigned int	dimension

Detailed Description

template<int dim>
class aspect::Utilities::VectorFunctionFromVelocityFunctionObject< dim >

Conversion object where one can provide a function that returns a tensor for the velocity at a given point and it returns something that matches the Function interface with a number of output components equal to the number of components of the finite element in use.

This function is a special case of the VectorFunctionFromTensorFunctionObject class.

Definition at line 1114 of file utilities.h.

Constructor & Destructor Documentation

VectorFunctionFromVelocityFunctionObject()

template<int dim>

aspect::Utilities::VectorFunctionFromVelocityFunctionObject< dim >::VectorFunctionFromVelocityFunctionObject	(	const unsigned int	n_components,
		const std::function< Tensor< 1, dim >(const Point< dim > &)> &	function_object
	)

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

Parameters

n_components	total number of components of the finite element system.
function_object	The function that will form the first dim components of the resulting Function object.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/latest/include/aspect/utilities.h