Compadre  1.5.7
Public Member Functions | Public Attributes | List of all members
Compadre::SamplingFunctional Struct Reference

Detailed Description

Definition at line 132 of file Compadre_Operators.hpp.

#include <Compadre_Operators.hpp>

Public Member Functions

constexpr KOKKOS_INLINE_FUNCTION SamplingFunctional (const int input_rank_, const int output_rank_, const bool use_target_site_weights_, const bool nontrivial_nullspace_, const int transform_type_, const int id_)
 
constexpr KOKKOS_INLINE_FUNCTION bool operator== (const SamplingFunctional sf) const
 
constexpr KOKKOS_INLINE_FUNCTION bool operator!= (const SamplingFunctional sf) const
 

Public Attributes

size_t id
 for uniqueness More...
 
int input_rank
 Rank of sampling functional input for each SamplingFunctional. More...
 
int output_rank
 Rank of sampling functional output for each SamplingFunctional. More...
 
bool use_target_site_weights
 Whether or not the SamplingTensor acts on the target site as well as the neighbors. More...
 
bool nontrivial_nullspace
 Whether the SamplingFunctional + ReconstructionSpace results in a nontrivial nullspace. More...
 
int transform_type
 Describes the SamplingFunction relationship to targets, neighbors. More...
 

Constructor & Destructor Documentation

◆ SamplingFunctional()

constexpr KOKKOS_INLINE_FUNCTION Compadre::SamplingFunctional::SamplingFunctional ( const int  input_rank_,
const int  output_rank_,
const bool  use_target_site_weights_,
const bool  nontrivial_nullspace_,
const int  transform_type_,
const int  id_ 
)
inlineconstexpr

Definition at line 149 of file Compadre_Operators.hpp.

Member Function Documentation

◆ operator!=()

constexpr KOKKOS_INLINE_FUNCTION bool Compadre::SamplingFunctional::operator!= ( const SamplingFunctional  sf) const
inlineconstexpr

Definition at line 162 of file Compadre_Operators.hpp.

◆ operator==()

constexpr KOKKOS_INLINE_FUNCTION bool Compadre::SamplingFunctional::operator== ( const SamplingFunctional  sf) const
inlineconstexpr

Definition at line 157 of file Compadre_Operators.hpp.

Member Data Documentation

◆ id

size_t Compadre::SamplingFunctional::id

for uniqueness

Definition at line 134 of file Compadre_Operators.hpp.

◆ input_rank

int Compadre::SamplingFunctional::input_rank

Rank of sampling functional input for each SamplingFunctional.

Definition at line 136 of file Compadre_Operators.hpp.

◆ nontrivial_nullspace

bool Compadre::SamplingFunctional::nontrivial_nullspace

Whether the SamplingFunctional + ReconstructionSpace results in a nontrivial nullspace.

Definition at line 143 of file Compadre_Operators.hpp.

◆ output_rank

int Compadre::SamplingFunctional::output_rank

Rank of sampling functional output for each SamplingFunctional.

Definition at line 138 of file Compadre_Operators.hpp.

◆ transform_type

int Compadre::SamplingFunctional::transform_type

Describes the SamplingFunction relationship to targets, neighbors.

Definition at line 145 of file Compadre_Operators.hpp.

◆ use_target_site_weights

bool Compadre::SamplingFunctional::use_target_site_weights

Whether or not the SamplingTensor acts on the target site as well as the neighbors.

This makes sense only in staggered schemes, when each target site is also a source site

Definition at line 141 of file Compadre_Operators.hpp.


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