viennashe::util::spatial_quantity< DeviceType, ElementTagT, ValueType > Class Template Reference

A functor-style wrapper for a spatial quantity which is externally prescribed by the user. More...

#include <misc.hpp>

Public Types
typedef viennagrid::result_of::element< MeshType, ElementTagT >::type	element_type
typedef ValueType	value_type

Public Member Functions
	spatial_quantity (DeviceType const &device, ValueType default_value=ValueType())
	Copy over all values from the accessors so that this object can be easily passed around. More...
value_type	operator() (element_type const &t) const
	The functor interface. More...
void	set (element_type const &t, ValueType val)

Detailed Description

template<typename DeviceType, typename ElementTagT, typename ValueType = double>
class viennashe::util::spatial_quantity< DeviceType, ElementTagT, ValueType >

A functor-style wrapper for a spatial quantity which is externally prescribed by the user.

Template Parameters

DeviceType	Type of the underlying device
dim	Topological dimension of the elements on which the quantity is defined (0: vertices)
ValueType	Value type of the quantity (usually double or bool)

Definition at line 336 of file misc.hpp.

Member Typedef Documentation

element_type

template<typename DeviceType , typename ElementTagT , typename ValueType = double>

typedef viennagrid::result_of::element<MeshType,ElementTagT>::type viennashe::util::spatial_quantity< DeviceType, ElementTagT, ValueType >::element_type

Definition at line 343 of file misc.hpp.

value_type

template<typename DeviceType , typename ElementTagT , typename ValueType = double>

typedef ValueType viennashe::util::spatial_quantity< DeviceType, ElementTagT, ValueType >::value_type

Definition at line 344 of file misc.hpp.

Constructor & Destructor Documentation

spatial_quantity()

template<typename DeviceType , typename ElementTagT , typename ValueType = double>

viennashe::util::spatial_quantity< DeviceType, ElementTagT, ValueType >::spatial_quantity ( DeviceType const &  device, ValueType  default_value = ValueType()  )

inline

Copy over all values from the accessors so that this object can be easily passed around.

Definition at line 347 of file misc.hpp.

Member Function Documentation

operator()()

template<typename DeviceType , typename ElementTagT , typename ValueType = double>

value_type viennashe::util::spatial_quantity< DeviceType, ElementTagT, ValueType >::operator() ( element_type const &  t ) const

inline

The functor interface.

Definition at line 350 of file misc.hpp.

set()

template<typename DeviceType , typename ElementTagT , typename ValueType = double>

void viennashe::util::spatial_quantity< DeviceType, ElementTagT, ValueType >::set ( element_type const &  t, ValueType  val  )

inline

Definition at line 355 of file misc.hpp.

---

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

• viennashe/util/misc.hpp