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

Class that represents the spectral space. More...

#include <SpectralKSpace.H>

Inheritance diagram for SpectralKSpace:
SpectralKSpaceRZ

Public Member Functions

 SpectralKSpace ()
 
 SpectralKSpace (const amrex::BoxArray &realspace_ba, const amrex::DistributionMapping &dm, amrex::RealVect realspace_dx)
 
KVectorComponent getKComponent (const amrex::DistributionMapping &dm, const amrex::BoxArray &realspace_ba, int i_dim, bool only_positive_k) const
 
KVectorComponent getModifiedKComponent (const amrex::DistributionMapping &dm, int i_dim, int n_order, short grid_type) const
 
SpectralShiftFactor getSpectralShiftFactor (const amrex::DistributionMapping &dm, int i_dim, int shift_type) const
 

Public Attributes

amrex::BoxArray spectralspace_ba
 

Protected Attributes

amrex::Array< KVectorComponent, AMREX_SPACEDIM > k_vec
 
amrex::RealVect dx
 

Detailed Description

Class that represents the spectral space.

(Contains info about the size of the spectral space corresponding to each box in realspace_ba, as well as the value of the corresponding k coordinates)

Constructor & Destructor Documentation

◆ SpectralKSpace() [1/2]

SpectralKSpace::SpectralKSpace ( )
inline

◆ SpectralKSpace() [2/2]

SpectralKSpace::SpectralKSpace ( const amrex::BoxArray realspace_ba,
const amrex::DistributionMapping dm,
amrex::RealVect  realspace_dx 
)

Member Function Documentation

◆ getKComponent()

KVectorComponent SpectralKSpace::getKComponent ( const amrex::DistributionMapping dm,
const amrex::BoxArray realspace_ba,
int  i_dim,
bool  only_positive_k 
) const

◆ getModifiedKComponent()

KVectorComponent SpectralKSpace::getModifiedKComponent ( const amrex::DistributionMapping dm,
int  i_dim,
int  n_order,
short  grid_type 
) const

◆ getSpectralShiftFactor()

SpectralShiftFactor SpectralKSpace::getSpectralShiftFactor ( const amrex::DistributionMapping dm,
int  i_dim,
int  shift_type 
) const

Member Data Documentation

◆ dx

amrex::RealVect SpectralKSpace::dx
protected

◆ k_vec

amrex::Array<KVectorComponent, AMREX_SPACEDIM> SpectralKSpace::k_vec
protected

◆ spectralspace_ba

amrex::BoxArray SpectralKSpace::spectralspace_ba

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