Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace > Struct Template Reference

Container for multi-dimensional product of 1-D eigenfunctions/values. More...

#include <Stokhos_KL_ProductEigenPair.hpp>

Public Types

typedef eigen_function_type::value_type value_type
 
typedef ExecutionSpace execution_space
 
typedef OneDEigenPair< eigen_function_type > one_d_eigen_pair_type
 
typedef Teuchos::Array< one_d_eigen_pair_typeeig_pair_type
 

Public Member Functions

 ProductEigenPair ()
 Default constructor.
 
 ProductEigenPair (const ProductEigenPair &ep)
 Copy constructor.
 
ProductEigenPairoperator= (const ProductEigenPair &ep)
 Assignment.
 
void set (const Teuchos::Array< one_d_eigen_pair_type > &ep)
 Set eigen pairs.
 
template<typename point_type >
KOKKOS_INLINE_FUNCTION value_type evalEigenfunction (const point_type &x) const
 Evaluate eigenfunction at a given point.
 
void print (std::ostream &os) const
 Print eigenpair.
 

Public Attributes

value_type eig_val
 Product eigenvalue.
 
eig_pair_type eig_pairs
 Eigenpairs for each dimension.
 

Detailed Description

template<typename eigen_function_type, typename ExecutionSpace>
struct Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >

Container for multi-dimensional product of 1-D eigenfunctions/values.

Definition at line 53 of file Stokhos_KL_ProductEigenPair.hpp.

Member Typedef Documentation

◆ value_type

template<typename eigen_function_type , typename ExecutionSpace >
typedef eigen_function_type::value_type Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::value_type

Definition at line 55 of file Stokhos_KL_ProductEigenPair.hpp.

◆ execution_space

template<typename eigen_function_type , typename ExecutionSpace >
typedef ExecutionSpace Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::execution_space

Definition at line 56 of file Stokhos_KL_ProductEigenPair.hpp.

◆ one_d_eigen_pair_type

template<typename eigen_function_type , typename ExecutionSpace >
typedef OneDEigenPair<eigen_function_type> Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::one_d_eigen_pair_type

Definition at line 57 of file Stokhos_KL_ProductEigenPair.hpp.

◆ eig_pair_type

template<typename eigen_function_type , typename ExecutionSpace >
typedef Teuchos::Array<one_d_eigen_pair_type> Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::eig_pair_type

Definition at line 58 of file Stokhos_KL_ProductEigenPair.hpp.

Constructor & Destructor Documentation

◆ ProductEigenPair() [1/2]

template<typename eigen_function_type , typename ExecutionSpace >
Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::ProductEigenPair ( )
inline

Default constructor.

Definition at line 67 of file Stokhos_KL_ProductEigenPair.hpp.

◆ ProductEigenPair() [2/2]

template<typename eigen_function_type , typename ExecutionSpace >
Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::ProductEigenPair ( const ProductEigenPair< eigen_function_type, ExecutionSpace > & ep)
inline

Copy constructor.

Definition at line 70 of file Stokhos_KL_ProductEigenPair.hpp.

Member Function Documentation

◆ operator=()

template<typename eigen_function_type , typename ExecutionSpace >
ProductEigenPair & Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::operator= ( const ProductEigenPair< eigen_function_type, ExecutionSpace > & ep)
inline

Assignment.

Definition at line 74 of file Stokhos_KL_ProductEigenPair.hpp.

◆ set()

template<typename eigen_function_type , typename ExecutionSpace >
void Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::set ( const Teuchos::Array< one_d_eigen_pair_type > & ep)
inline

Set eigen pairs.

Definition at line 83 of file Stokhos_KL_ProductEigenPair.hpp.

◆ evalEigenfunction()

template<typename eigen_function_type , typename ExecutionSpace >
template<typename point_type >
KOKKOS_INLINE_FUNCTION value_type Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::evalEigenfunction ( const point_type & x) const
inline

Evaluate eigenfunction at a given point.

Definition at line 94 of file Stokhos_KL_ProductEigenPair.hpp.

◆ print()

template<typename eigen_function_type , typename ExecutionSpace >
void Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::print ( std::ostream & os) const
inline

Print eigenpair.

Definition at line 103 of file Stokhos_KL_ProductEigenPair.hpp.

Member Data Documentation

◆ eig_val

template<typename eigen_function_type , typename ExecutionSpace >
value_type Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::eig_val

Product eigenvalue.

Definition at line 61 of file Stokhos_KL_ProductEigenPair.hpp.

◆ eig_pairs

template<typename eigen_function_type , typename ExecutionSpace >
eig_pair_type Stokhos::KL::ProductEigenPair< eigen_function_type, ExecutionSpace >::eig_pairs

Eigenpairs for each dimension.

Definition at line 64 of file Stokhos_KL_ProductEigenPair.hpp.


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