WarpX
Public Types | Public Member Functions | Protected Attributes | List of all members
SpectralBinomialFilter Class Reference

Class that sets up binomial filtering in k space. More...

#include <SpectralBinomialFilter.H>

Public Types

using KFilterArray = amrex::Gpu::DeviceVector< amrex::Real >
 

Public Member Functions

 SpectralBinomialFilter ()=default
 
void InitFilterArray (RealKVector const &kvec, amrex::Real dels, int npasses, bool compensation, KFilterArray &filter)
 
void InitFilterArray (RealKVector const &kr, RealKVector const &kz, amrex::RealVect dx, amrex::IntVect filter_npass_each_dir, bool compensation)
 
KFilterArray const & getFilterArrayR ()
 
KFilterArray const & getFilterArrayZ ()
 

Protected Attributes

KFilterArray filter_r
 
KFilterArray filter_z
 

Detailed Description

Class that sets up binomial filtering in k space.

Contains the filter arrays for r and z.

Member Typedef Documentation

◆ KFilterArray

Constructor & Destructor Documentation

◆ SpectralBinomialFilter()

SpectralBinomialFilter::SpectralBinomialFilter ( )
default

Member Function Documentation

◆ getFilterArrayR()

KFilterArray const& SpectralBinomialFilter::getFilterArrayR ( )
inline

◆ getFilterArrayZ()

KFilterArray const& SpectralBinomialFilter::getFilterArrayZ ( )
inline

◆ InitFilterArray() [1/2]

void SpectralBinomialFilter::InitFilterArray ( RealKVector const &  kr,
RealKVector const &  kz,
amrex::RealVect  dx,
amrex::IntVect  filter_npass_each_dir,
bool  compensation 
)

◆ InitFilterArray() [2/2]

void SpectralBinomialFilter::InitFilterArray ( RealKVector const &  kvec,
amrex::Real  dels,
int  npasses,
bool  compensation,
KFilterArray filter 
)

Member Data Documentation

◆ filter_r

KFilterArray SpectralBinomialFilter::filter_r
protected

◆ filter_z

KFilterArray SpectralBinomialFilter::filter_z
protected

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