Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | List of all members
Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector > Class Template Reference

Expression template forward-mode AD class with static memory allocation. More...

#include <Sacado_Fad_SFad_MP_Vector.hpp>

Public Types

typedef Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > > T
 
typedef RemoveConst< T >::type value_type
 Typename of values.
 
typedef ScalarType< value_type >::type scalar_type
 Typename of scalar's (which may be different from T)
 
typedef SFad< value_type, Num > base_expr_type
 Typename of base-expressions.
 
typedef value_type::value_type val_type
 

Assignment operators

T val_
 Value.
 
template<typename S >
KOKKOS_INLINE_FUNCTION SACADO_ENABLE_VALUE_FUNC (Expr &) operator
 Assignment operator with constant right-hand-side.
 

Initialization methods

KOKKOS_INLINE_FUNCTION Expr ()
 Default constructor.
 
template<typename S >
KOKKOS_INLINE_FUNCTION Expr (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
 Constructor with supplied value x.
 
KOKKOS_INLINE_FUNCTION Expr (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
 Constructor with size sz and value x.
 
KOKKOS_INLINE_FUNCTION Expr (const int sz, const int i, const T &x)
 Constructor with size sz, index i, and value x.
 
KOKKOS_INLINE_FUNCTION Expr (const Expr &x)
 Copy constructor.
 
template<typename S >
KOKKOS_INLINE_FUNCTION Expr (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL)
 Copy constructor from any Expression object.
 
KOKKOS_INLINE_FUNCTION ~Expr ()
 Destructor.
 
KOKKOS_INLINE_FUNCTION void diff (const int ith, const int n)
 Set Fad object as the ith independent variable.
 
KOKKOS_INLINE_FUNCTION void resize (int sz)
 Resize derivative array to length sz.
 
KOKKOS_INLINE_FUNCTION void expand (int sz)
 Expand derivative array to size sz.
 
KOKKOS_INLINE_FUNCTION void zero ()
 Zero out the derivative array.
 
KOKKOS_INLINE_FUNCTION void setUpdateValue (bool update_val)
 Set whether this Fad object should update values.
 
KOKKOS_INLINE_FUNCTION bool updateValue () const
 Return whether this Fad object has an updated value.
 
template<typename S >
KOKKOS_INLINE_FUNCTION SACADO_ENABLE_EXPR_FUNC (bool) isEqualTo(const Expr< S > &x) const
 Returns whether two Fad objects have the same values.
 

Value accessor methods

KOKKOS_INLINE_FUNCTION const Tval () const
 Returns value.
 
KOKKOS_INLINE_FUNCTION Tval ()
 Returns value.
 
KOKKOS_INLINE_FUNCTION const val_typeval (int j) const
 Returns value.
 
KOKKOS_INLINE_FUNCTION val_typeval (int j)
 Returns value.
 

Derivative accessor methods

KOKKOS_INLINE_FUNCTION int size () const
 Returns number of derivative components.
 
KOKKOS_INLINE_FUNCTION int availableSize () const
 Returns number of derivative components that can be stored without reallocation.
 
KOKKOS_INLINE_FUNCTION bool hasFastAccess () const
 Returns true if derivative array is not empty.
 
KOKKOS_INLINE_FUNCTION bool isPassive () const
 Returns true if derivative array is empty.
 
KOKKOS_INLINE_FUNCTION void setIsConstant (bool is_const)
 Set whether variable is constant.
 
KOKKOS_INLINE_FUNCTION const Tdx () const
 Returns derivative array.
 
KOKKOS_INLINE_FUNCTION const Tdx (int i) const
 Returns derivative component i with bounds checking.
 
KOKKOS_INLINE_FUNCTION TfastAccessDx (int i)
 Returns derivative component i without bounds checking.
 
KOKKOS_INLINE_FUNCTION const TfastAccessDx (int i) const
 Returns derivative component i without bounds checking.
 
KOKKOS_INLINE_FUNCTION const val_typedx (int i, int j) const
 Returns derivative component i with bounds checking.
 
KOKKOS_INLINE_FUNCTION val_typefastAccessDx (int i, int j)
 Returns derivative component i without bounds checking.
 
KOKKOS_INLINE_FUNCTION const val_typefastAccessDx (int i, int j) const
 Returns derivative component i without bounds checking.
 

Detailed Description

template<typename Ord, typename Val, int VecNum, typename Dev, int Num>
class Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >

Expression template forward-mode AD class with static memory allocation.

This classes specializes Expr to SFad expressions.

Definition at line 88 of file Sacado_Fad_SFad_MP_Vector.hpp.

Member Typedef Documentation

◆ T

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
typedef Sacado::MP::Vector< Stokhos::StaticFixedStorage<Ord,Val,VecNum,Dev> > Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::T

Definition at line 92 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ value_type

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
typedef RemoveConst<T>::type Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::value_type

Typename of values.

Definition at line 95 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ scalar_type

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
typedef ScalarType<value_type>::type Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::scalar_type

Typename of scalar's (which may be different from T)

Definition at line 98 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ base_expr_type

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
typedef SFad<value_type,Num> Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::base_expr_type

Typename of base-expressions.

Definition at line 101 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ val_type

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
typedef value_type::value_type Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::val_type

Definition at line 103 of file Sacado_Fad_SFad_MP_Vector.hpp.

Constructor & Destructor Documentation

◆ Expr() [1/6]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::Expr ( )
inline

Default constructor.

Definition at line 112 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ Expr() [2/6]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
template<typename S >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::Expr ( const S &  x,
SACADO_ENABLE_VALUE_CTOR_DECL   
)
inline

Constructor with supplied value x.

Initializes value to x and derivative array is empty

Definition at line 121 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ Expr() [3/6]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::Expr ( const int  sz,
const T x,
const DerivInit  zero_out = InitDerivArray 
)
inline

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 131 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ Expr() [4/6]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::Expr ( const int  sz,
const int  i,
const T x 
)
inline

Constructor with size sz, index i, and value x.

Initializes value to x and derivative array of length sz as row i of the identity matrix, i.e., sets derivative component i to 1 and all other's to zero.

Definition at line 147 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ Expr() [5/6]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::Expr ( const Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector > &  x)
inline

Copy constructor.

Definition at line 162 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ Expr() [6/6]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
template<typename S >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::Expr ( const Expr< S > &  x,
SACADO_ENABLE_EXPR_CTOR_DECL   
)
inline

Copy constructor from any Expression object.

Definition at line 171 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ ~Expr()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::~Expr ( )
inline

Destructor.

Definition at line 188 of file Sacado_Fad_SFad_MP_Vector.hpp.

Member Function Documentation

◆ diff()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::diff ( const int  ith,
const int  n 
)
inline

Set Fad object as the ith independent variable.

Sets the derivative array of length n to the ith row of the identity matrix and has the same affect as the Implementation(const int sz, const int i, const T & x) constructor.

Definition at line 198 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ resize()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::resize ( int  sz)
inline

Resize derivative array to length sz.

Since the derivative array length is not dynamic, this method throws an error if compiled with SACADO_DEBUG defined.

Definition at line 214 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ expand()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::expand ( int  sz)
inline

Expand derivative array to size sz.

Since the derivative array length is not dynamic, this method throws an error if compiled with SACADO_DEBUG defined.

Definition at line 227 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ zero()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::zero ( )
inline

Zero out the derivative array.

Definition at line 231 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ setUpdateValue()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::setUpdateValue ( bool  update_val)
inline

Set whether this Fad object should update values.

Definition at line 235 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ updateValue()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION bool Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::updateValue ( ) const
inline

Return whether this Fad object has an updated value.

Definition at line 239 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ SACADO_ENABLE_EXPR_FUNC()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
template<typename S >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::SACADO_ENABLE_EXPR_FUNC ( bool  ) const &
inline

Returns whether two Fad objects have the same values.

Definition at line 244 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ val() [1/4]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION const T & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::val ( ) const
inline

Returns value.

Definition at line 262 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ val() [2/4]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION T & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::val ( )
inline

Returns value.

Definition at line 266 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ val() [3/4]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION const val_type & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::val ( int  j) const
inline

Returns value.

Definition at line 270 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ val() [4/4]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION val_type & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::val ( int  j)
inline

Returns value.

Definition at line 274 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ size()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION int Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::size ( ) const
inline

Returns number of derivative components.

Definition at line 285 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ availableSize()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION int Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::availableSize ( ) const
inline

Returns number of derivative components that can be stored without reallocation.

Definition at line 292 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ hasFastAccess()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION bool Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::hasFastAccess ( ) const
inline

Returns true if derivative array is not empty.

Definition at line 296 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ isPassive()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION bool Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::isPassive ( ) const
inline

Returns true if derivative array is empty.

Definition at line 300 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ setIsConstant()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::setIsConstant ( bool  is_const)
inline

Set whether variable is constant.

Definition at line 304 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ dx() [1/3]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION const T * Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::dx ( ) const
inline

Returns derivative array.

Definition at line 308 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ dx() [2/3]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION const T & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::dx ( int  i) const
inline

Returns derivative component i with bounds checking.

Definition at line 312 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ fastAccessDx() [1/4]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION T & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::fastAccessDx ( int  i)
inline

Returns derivative component i without bounds checking.

Definition at line 316 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ fastAccessDx() [2/4]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION const T & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::fastAccessDx ( int  i) const
inline

Returns derivative component i without bounds checking.

Definition at line 320 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ dx() [3/3]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION const val_type & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::dx ( int  i,
int  j 
) const
inline

Returns derivative component i with bounds checking.

Definition at line 324 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ fastAccessDx() [3/4]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION val_type & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::fastAccessDx ( int  i,
int  j 
)
inline

Returns derivative component i without bounds checking.

Definition at line 328 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ fastAccessDx() [4/4]

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
KOKKOS_INLINE_FUNCTION const val_type & Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::fastAccessDx ( int  i,
int  j 
) const
inline

Returns derivative component i without bounds checking.

Definition at line 332 of file Sacado_Fad_SFad_MP_Vector.hpp.

◆ SACADO_ENABLE_VALUE_FUNC()

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
template<typename S >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::SACADO_ENABLE_VALUE_FUNC ( Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector > &  )

Assignment operator with constant right-hand-side.

Member Data Documentation

◆ val_

template<typename Ord , typename Val , int VecNum, typename Dev , int Num>
T Sacado::Fad::Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage< Ord, Val, VecNum, Dev > >, Num >, ExprSpecMPVector >::val_

Value.

Definition at line 520 of file Sacado_Fad_SFad_MP_Vector.hpp.


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