Sacado Package Browser (Single Doxygen Collection): Sacado::Fad::VectorDynamicStorage< T, U > Class Template Reference

Sacado Package Browser (Single Doxygen Collection) Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

Derivative array storage class using dynamic memory allocation. More...

#include <Sacado_Fad_VectorDynamicStorage.hpp>

Public Types
typedef T	value_type

Public Member Functions
template<typename S >
KOKKOS_INLINE_FUNCTION	VectorDynamicStorage (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Default constructor. More...

KOKKOS_INLINE_FUNCTION	VectorDynamicStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size `sz`. More...

KOKKOS_INLINE_FUNCTION	VectorDynamicStorage (const int sz, T x, U dx_p, const int stride, bool zero_out)
	Constructor with supplied memory. More...

KOKKOS_INLINE_FUNCTION	VectorDynamicStorage (const VectorDynamicStorage &x)
	Copy constructor. More...

KOKKOS_INLINE_FUNCTION	~VectorDynamicStorage ()
	Destructor. More...

KOKKOS_INLINE_FUNCTION VectorDynamicStorage &	operator= (const VectorDynamicStorage &x)
	Assignment. More...

KOKKOS_INLINE_FUNCTION int	size () const
	Returns number of derivative components. More...

KOKKOS_INLINE_FUNCTION int	length () const
	Returns array length. More...

KOKKOS_INLINE_FUNCTION void	resize (int sz)
	Resize the derivative array to sz. More...

KOKKOS_INLINE_FUNCTION void	resizeAndZero (int sz)
	Resize the derivative array to sz. More...

KOKKOS_INLINE_FUNCTION void	expand (int sz)
	Expand derivative array to size sz. More...

KOKKOS_INLINE_FUNCTION void	zero ()
	Zero out derivative array. More...

KOKKOS_INLINE_FUNCTION void	setMemory (int sz, T x, U dx_p, int stride)
	Set value/derivative array memory. More...

KOKKOS_INLINE_FUNCTION const T &	val () const
	Returns value. More...

KOKKOS_INLINE_FUNCTION T &	val ()
	Returns value. More...

KOKKOS_INLINE_FUNCTION const U *	dx () const
	Returns derivative array. More...

KOKKOS_INLINE_FUNCTION U	dx (int i) const
	Returns derivative component `i` with bounds checking. More...

KOKKOS_INLINE_FUNCTION U &	fastAccessDx (int i)
	Returns derivative component `i` without bounds checking. More...

KOKKOS_INLINE_FUNCTION const U &	fastAccessDx (int i) const
	Returns derivative component `i` without bounds checking. More...

Private Attributes
T	v_

bool	owns_mem
	Do we own the val/dx storage. More...

int	sz_
	Derivative array size. More...

int	len_
	Derivative array length. More...

int	stride_
	Derivative array stride. More...

T *	val_
	Value. More...

U *	dx_
	Derivative array. More...

Detailed Description

template<typename T, typename U = T>
class Sacado::Fad::VectorDynamicStorage< T, U >

Derivative array storage class using dynamic memory allocation.

Definition at line 59 of file Sacado_Fad_VectorDynamicStorage.hpp.

Member Typedef Documentation

template<typename T , typename U = T>

typedef T Sacado::Fad::VectorDynamicStorage< T, U >::value_type

Definition at line 63 of file Sacado_Fad_VectorDynamicStorage.hpp.

Constructor & Destructor Documentation

template<typename T , typename U = T>

template<typename S >

KOKKOS_INLINE_FUNCTION Sacado::Fad::VectorDynamicStorage< T, U >::VectorDynamicStorage	(	const S &	x,
		SACADO_ENABLE_VALUE_CTOR_DECL
	)

inline

Default constructor.

Definition at line 68 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION Sacado::Fad::VectorDynamicStorage< T, U >::VectorDynamicStorage	(	const int	sz,
		const T &	x,
		const DerivInit	zero_out = `InitDerivArray`
	)

inline

Constructor with size sz.

Initializes derivative array 0 of length sz

Definition at line 77 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION Sacado::Fad::VectorDynamicStorage< T, U >::VectorDynamicStorage	(	const int	sz,
		T *	x,
		U *	dx_p,
		const int	stride,
		bool	zero_out
	)

inline

Constructor with supplied memory.

Definition at line 87 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION Sacado::Fad::VectorDynamicStorage< T, U >::VectorDynamicStorage ( const VectorDynamicStorage< T, U > & x )

inline

Copy constructor.

Definition at line 97 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION Sacado::Fad::VectorDynamicStorage< T, U >::~VectorDynamicStorage ( )

inline

Destructor.

Definition at line 105 of file Sacado_Fad_VectorDynamicStorage.hpp.

Member Function Documentation

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION VectorDynamicStorage& Sacado::Fad::VectorDynamicStorage< T, U >::operator= ( const VectorDynamicStorage< T, U > & x )

inline

Assignment.

Definition at line 114 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION int Sacado::Fad::VectorDynamicStorage< T, U >::size ( ) const

inline

Returns number of derivative components.

Definition at line 140 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION int Sacado::Fad::VectorDynamicStorage< T, U >::length ( ) const

inline

Returns array length.

Definition at line 144 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION void Sacado::Fad::VectorDynamicStorage< T, U >::resize ( int sz )

inline

Resize the derivative array to sz.

Note: This does not necessarily preserve derivative components.

Definition at line 151 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION void Sacado::Fad::VectorDynamicStorage< T, U >::resizeAndZero ( int sz )

inline

Resize the derivative array to sz.

This method doest not preserve any existing derivative components but sets any that are added to zero.

Definition at line 171 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION void Sacado::Fad::VectorDynamicStorage< T, U >::expand ( int sz )

inline

Expand derivative array to size sz.

This method preserves any existing derivative components and sets any that are added to zero.

Definition at line 193 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION void Sacado::Fad::VectorDynamicStorage< T, U >::zero ( )

inline

Zero out derivative array.

Definition at line 213 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION void Sacado::Fad::VectorDynamicStorage< T, U >::setMemory	(	int	sz,
		T *	x,
		U *	dx_p,
		int	stride
	)

inline

Set value/derivative array memory.

Definition at line 219 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION const T& Sacado::Fad::VectorDynamicStorage< T, U >::val ( ) const

inline

Returns value.

Definition at line 238 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION T& Sacado::Fad::VectorDynamicStorage< T, U >::val ( )

inline

Returns value.

Definition at line 242 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION const U* Sacado::Fad::VectorDynamicStorage< T, U >::dx ( ) const

inline

Returns derivative array.

Definition at line 246 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION U Sacado::Fad::VectorDynamicStorage< T, U >::dx ( int i ) const

inline

Returns derivative component i with bounds checking.

Definition at line 250 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION U& Sacado::Fad::VectorDynamicStorage< T, U >::fastAccessDx ( int i )

inline

Returns derivative component i without bounds checking.

Definition at line 254 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

KOKKOS_INLINE_FUNCTION const U& Sacado::Fad::VectorDynamicStorage< T, U >::fastAccessDx ( int i ) const

inline

Returns derivative component i without bounds checking.

Definition at line 258 of file Sacado_Fad_VectorDynamicStorage.hpp.

Member Data Documentation

template<typename T , typename U = T>

T Sacado::Fad::VectorDynamicStorage< T, U >::v_

private

Definition at line 262 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

bool Sacado::Fad::VectorDynamicStorage< T, U >::owns_mem

private

Do we own the val/dx storage.

Definition at line 267 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

int Sacado::Fad::VectorDynamicStorage< T, U >::sz_

private

Derivative array size.

Definition at line 270 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

int Sacado::Fad::VectorDynamicStorage< T, U >::len_

private

Derivative array length.

Definition at line 273 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

int Sacado::Fad::VectorDynamicStorage< T, U >::stride_

private

Derivative array stride.

Definition at line 276 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

T* Sacado::Fad::VectorDynamicStorage< T, U >::val_

private

Definition at line 279 of file Sacado_Fad_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

U* Sacado::Fad::VectorDynamicStorage< T, U >::dx_

private

Derivative array.

Definition at line 282 of file Sacado_Fad_VectorDynamicStorage.hpp.

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

Sacado_Fad_VectorDynamicStorage.hpp