MathTL::Function< DIM, VALUE > Class Template Reference

#include <function.h>

Inheritance diagram for MathTL::Function< DIM, VALUE >:

List of all members.

Public Types
typedef size_t	size_type
Public Member Functions
	Function (const unsigned int n_components=1, const double initial_time=0.0)
virtual	~Function ()=0
virtual VALUE	value (const Point< DIM, VALUE > &p, const unsigned int component=0) const =0
virtual void	vector_value (const Point< DIM, VALUE > &p, Vector< VALUE > &values) const =0
const size_type	memory_consumption () const
Public Attributes
const unsigned int	n_components
Static Public Attributes
static const unsigned int	dimension = DIM

---

Detailed Description

template<unsigned int DIM, class VALUE = double>
class MathTL::Function< DIM, VALUE >

Base class for scalar or vector-valued functions on R^d

(this function model is essentially compatible to that of the deal.II library, version 5)

---

Member Typedef Documentation

template<unsigned int DIM, class VALUE = double>

typedef size_t MathTL::Function< DIM, VALUE >::size_type

size type

---

Constructor & Destructor Documentation

template<unsigned int DIM, class VALUE >

MathTL::Function< DIM, VALUE >::Function	(	const unsigned int	n_components = 1,
		const double	initial_time = 0.0
	)		[inline]

default constructor: with the default values, this yields a scalar function with initial time value 0.

template<unsigned int DIM, class VALUE >

MathTL::Function< DIM, VALUE >::~Function

(

)

[inline, pure virtual]

purely virtual destructor

---

Member Function Documentation

template<unsigned int DIM, class VALUE >

const Function< DIM, VALUE >::size_type MathTL::Function< DIM, VALUE >::memory_consumption

(

)

const [inline]

(estimate of) memory consumption in bytes

template<unsigned int DIM, class VALUE = double>

virtual VALUE MathTL::Function< DIM, VALUE >::value	(	const Point< DIM, VALUE > &	p,
		const unsigned int	component = 0
	)		const [pure virtual]

evaluate (a component of) the function

Implemented in MathTL::ProductFunction< DIM, VALUE >, MathTL::ConstantFunction< DIM, VALUE >, and MathTL::ZeroFunction< DIM, VALUE >.

template<unsigned int DIM, class VALUE = double>

virtual void MathTL::Function< DIM, VALUE >::vector_value	(	const Point< DIM, VALUE > &	p,
		Vector< VALUE > &	values
	)		const [pure virtual]

evaluate the function (values should be of appropriate size)

Implemented in MathTL::ProductFunction< DIM, VALUE >, MathTL::ConstantFunction< DIM, VALUE >, and MathTL::ZeroFunction< DIM, VALUE >.

---

Member Data Documentation

template<unsigned int DIM, class VALUE = double>

const unsigned int MathTL::Function< DIM, VALUE >::dimension = DIM [static]

make template parameter value accessible

template<unsigned int DIM, class VALUE = double>

const unsigned int MathTL::Function< DIM, VALUE >::n_components

dimension of value

---

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

• utils/function.h
• utils/function.cpp