ewalena::ScalarFieldBase< dim, ValueType > Class Template Reference

Base class for scalar fields of empirical moduli. More...

#include <include/ewalena/base/scalar_field_base.h>

List of all members.

Public Member Functions
virtual ValueType	grad (const Point< dim, ValueType > &point) const
virtual Tensor< dim, 1, ValueType >	gradient (const Point< dim, ValueType > &point) const
virtual void	gradient_list (const std::vector< Point< dim, ValueType > > &points, std::vector< Tensor< dim, 1, ValueType > > &gradients)
virtual Tensor< dim, 2, ValueType >	hessian (const Point< dim, ValueType > &point) const
virtual void	hessian_list (const std::vector< Point< dim, ValueType > > &points, std::vector< Tensor< dim, 2, ValueType > > &hessianss)
virtual ValueType	laplace (const Point< dim, ValueType > &point) const
	ScalarFieldBase ()
virtual ValueType	value (const Point< dim, ValueType > &point) const
virtual void	value_list (const std::vector< Point< dim, ValueType > > &points, std::vector< ValueType > &values)
virtual	~ScalarFieldBase ()
Static Public Attributes
static const unsigned int	dim_ = dim

---

Detailed Description

template<int dim, typename ValueType = double>
class ewalena::ScalarFieldBase< dim, ValueType >

Base class for scalar fields of empirical moduli.

A base class that describes a super set of classical scalar fields.

Author:

Toby D. Young 2009, 2012.

---

Constructor & Destructor Documentation

template<int dim, typename ValueType = double>

ewalena::ScalarFieldBase< dim, ValueType >::ScalarFieldBase

(

)

Constructor.

template<int dim, typename ValueType = double>

virtual ewalena::ScalarFieldBase< dim, ValueType >::~ScalarFieldBase

(

)

[virtual]

Virtual donstructor.

---

Member Function Documentation

template<int dim, typename ValueType = double>

virtual ValueType ewalena::ScalarFieldBase< dim, ValueType >::grad

(

const Point< dim, ValueType > &

point

)

const [virtual]

Return the value of the gradient of this function at the given point.

template<int dim, typename ValueType = double>

virtual Tensor<dim, 1, ValueType> ewalena::ScalarFieldBase< dim, ValueType >::gradient

(

const Point< dim, ValueType > &

point

)

const [virtual]

Return the gradient of this function at the given point.

template<int dim, typename ValueType = double>

virtual void ewalena::ScalarFieldBase< dim, ValueType >::gradient_list	(	const std::vector< Point< dim, ValueType > > &	points,
		std::vector< Tensor< dim, 1, ValueType > > &	gradients
	)		[virtual]

Return the list of gradients of this function at the given list of points. The original data and size of values (if any) is anihilated.

template<int dim, typename ValueType = double>

virtual Tensor<dim, 2, ValueType> ewalena::ScalarFieldBase< dim, ValueType >::hessian

(

const Point< dim, ValueType > &

point

)

const [virtual]

Return the Hessian (or funcional determinant) of this function at the given point.

template<int dim, typename ValueType = double>

virtual void ewalena::ScalarFieldBase< dim, ValueType >::hessian_list	(	const std::vector< Point< dim, ValueType > > &	points,
		std::vector< Tensor< dim, 2, ValueType > > &	hessianss
	)		[virtual]

Return the list of hessians (or functional determinants) of this function at the given list of points. The original data and size of values (if any) is anihilated.

template<int dim, typename ValueType = double>

virtual ValueType ewalena::ScalarFieldBase< dim, ValueType >::laplace

(

const Point< dim, ValueType > &

point

)

const [virtual]

Return the value of the Laplace acting on this function at the given point.

template<int dim, typename ValueType = double>

virtual ValueType ewalena::ScalarFieldBase< dim, ValueType >::value

(

const Point< dim, ValueType > &

point

)

const [virtual]

Return the value of this function at the given point.

template<int dim, typename ValueType = double>

virtual void ewalena::ScalarFieldBase< dim, ValueType >::value_list	(	const std::vector< Point< dim, ValueType > > &	points,
		std::vector< ValueType > &	values
	)		[virtual]

Return the list of values of this function at the given list of points. The original data and size of values (if any) is anihilated.

---

Member Data Documentation

template<int dim, typename ValueType = double>

const unsigned int ewalena::ScalarFieldBase< dim, ValueType >::dim_ = dim [static]

Let the dimension of this function be public.

---

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

• include/ewalena/base/scalar_field_base.h