Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Stokhos::KL::ExponentialOneDEigenFunction< Value > Class Template Reference

One-dimensional eigenfunction for exponential covariance function. More...

#include <Stokhos_KL_OneDExponentialEigenPair.hpp>

Public Types

enum  TYPE { SIN , COS }
 Enum identifying the type of eigenfunction. More...
 
typedef Value value_type
 

Public Member Functions

KOKKOS_INLINE_FUNCTION ExponentialOneDEigenFunction ()
 Default Constructor.
 
KOKKOS_INLINE_FUNCTION ExponentialOneDEigenFunction (TYPE type_, const value_type &a_, const value_type &b_, const value_type &omega_, const int dim_name_)
 Constructor.
 
KOKKOS_INLINE_FUNCTION ~ExponentialOneDEigenFunction ()
 Destructor.
 
template<typename point_type >
KOKKOS_INLINE_FUNCTION point_type evaluate (const point_type &x) const
 Evaluate eigenfunction.
 
void print (std::ostream &os) const
 Print eigenfunction.
 
KOKKOS_INLINE_FUNCTION TYPE getType () const
 Return type.
 
KOKKOS_INLINE_FUNCTION value_type getFrequency () const
 Return frequency.
 
KOKKOS_INLINE_FUNCTION value_type getMultiplier () const
 Return multiplier.
 
KOKKOS_INLINE_FUNCTION value_type getShift () const
 Get shift.
 

Protected Attributes

TYPE type
 Type of eigenfunction (sin or cos)
 
value_type a
 Domain length.
 
value_type b
 Domain center.
 
value_type A
 Multiplier for eigenfunction.
 
value_type omega
 Frequency of eigenfunction.
 
int dim_name
 Dimesion name (e.g., x_1) for printing eigenfunction.
 

Detailed Description

template<typename Value>
class Stokhos::KL::ExponentialOneDEigenFunction< Value >

One-dimensional eigenfunction for exponential covariance function.

Represents an eigenfunction of the form $A \sin(\omega (x-(b+a)/2))$ or $A \cos(\omega (x-(b+a)/2))$ over the domain $[a,b]$ where

\[
  A = \frac{1}{\sqrt{\frac{b-a}{2} \pm \frac{\sin(\omega(b-a)}{2\omega}}}
\]

for $\cos$, $\sin$ respectively.

Definition at line 73 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

Member Typedef Documentation

◆ value_type

template<typename Value >
typedef Value Stokhos::KL::ExponentialOneDEigenFunction< Value >::value_type

Definition at line 76 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

Member Enumeration Documentation

◆ TYPE

template<typename Value >
enum Stokhos::KL::ExponentialOneDEigenFunction::TYPE

Enum identifying the type of eigenfunction.

Enumerator
SIN 

A*sin(omega*(x-b))

COS 

A*cos(omega*(x-b))

Definition at line 79 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

Constructor & Destructor Documentation

◆ ExponentialOneDEigenFunction() [1/2]

template<typename Value >
KOKKOS_INLINE_FUNCTION Stokhos::KL::ExponentialOneDEigenFunction< Value >::ExponentialOneDEigenFunction ( )
inline

Default Constructor.

Definition at line 86 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ ExponentialOneDEigenFunction() [2/2]

template<typename Value >
KOKKOS_INLINE_FUNCTION Stokhos::KL::ExponentialOneDEigenFunction< Value >::ExponentialOneDEigenFunction ( TYPE  type_,
const value_type a_,
const value_type b_,
const value_type omega_,
const int  dim_name_ 
)
inline

Constructor.

Definition at line 91 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ ~ExponentialOneDEigenFunction()

template<typename Value >
KOKKOS_INLINE_FUNCTION Stokhos::KL::ExponentialOneDEigenFunction< Value >::~ExponentialOneDEigenFunction ( )
inline

Destructor.

Definition at line 105 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

Member Function Documentation

◆ evaluate()

template<typename Value >
template<typename point_type >
KOKKOS_INLINE_FUNCTION point_type Stokhos::KL::ExponentialOneDEigenFunction< Value >::evaluate ( const point_type &  x) const
inline

Evaluate eigenfunction.

Definition at line 111 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ print()

template<typename Value >
void Stokhos::KL::ExponentialOneDEigenFunction< Value >::print ( std::ostream &  os) const
inline

Print eigenfunction.

Definition at line 118 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ getType()

template<typename Value >
KOKKOS_INLINE_FUNCTION TYPE Stokhos::KL::ExponentialOneDEigenFunction< Value >::getType ( ) const
inline

Return type.

Definition at line 129 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ getFrequency()

template<typename Value >
KOKKOS_INLINE_FUNCTION value_type Stokhos::KL::ExponentialOneDEigenFunction< Value >::getFrequency ( ) const
inline

Return frequency.

Definition at line 133 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ getMultiplier()

template<typename Value >
KOKKOS_INLINE_FUNCTION value_type Stokhos::KL::ExponentialOneDEigenFunction< Value >::getMultiplier ( ) const
inline

Return multiplier.

Definition at line 137 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ getShift()

template<typename Value >
KOKKOS_INLINE_FUNCTION value_type Stokhos::KL::ExponentialOneDEigenFunction< Value >::getShift ( ) const
inline

Get shift.

Definition at line 141 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

Member Data Documentation

◆ type

template<typename Value >
TYPE Stokhos::KL::ExponentialOneDEigenFunction< Value >::type
protected

Type of eigenfunction (sin or cos)

Definition at line 146 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ a

template<typename Value >
value_type Stokhos::KL::ExponentialOneDEigenFunction< Value >::a
protected

Domain length.

Definition at line 149 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ b

template<typename Value >
value_type Stokhos::KL::ExponentialOneDEigenFunction< Value >::b
protected

Domain center.

Definition at line 152 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ A

template<typename Value >
value_type Stokhos::KL::ExponentialOneDEigenFunction< Value >::A
protected

Multiplier for eigenfunction.

Definition at line 155 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ omega

template<typename Value >
value_type Stokhos::KL::ExponentialOneDEigenFunction< Value >::omega
protected

Frequency of eigenfunction.

Definition at line 158 of file Stokhos_KL_OneDExponentialEigenPair.hpp.

◆ dim_name

template<typename Value >
int Stokhos::KL::ExponentialOneDEigenFunction< Value >::dim_name
protected

Dimesion name (e.g., x_1) for printing eigenfunction.

Definition at line 161 of file Stokhos_KL_OneDExponentialEigenPair.hpp.


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