WARPXM v1.10.0
Loading...
Searching...
No Matches
warpy.post_processing.band_diagrams.density_profiles.Density1DArb Class Reference

Child of Density1D for arbitrary density functions. More...

Inheritance diagram for warpy.post_processing.band_diagrams.density_profiles.Density1DArb:
warpy.post_processing.band_diagrams.density_profiles.Density1D

Detailed Description

Child of Density1D for arbitrary density functions.

Public Member Functions

def __init__ (self, x, n)
 Calculates density profile attributes.
 
- Public Member Functions inherited from warpy.post_processing.band_diagrams.density_profiles.Density1D
def __init__ (self, x, **density_kwargs)
 Calculates initial density profile and it's attributes.
 
def calc_fourier_coeff (self, N=10)
 Calculate fourier coefficients of the density profile.
 
def plot_fourier_coeff (self, N=10)
 Plot fourier coefficents on bar graph.
 
def reconstruct (self)
 Calculates reconstruction of density profile using Fourier coeff.
 
def calc_error (self, ord=None)
 Uses numpy.linalg.norm() to calculate error norm of fourier approx.
 
def plot_reconstruction (self, N, ord=None)
 Plot set of reconstructions along with orginal profile.
 

Public Attributes

 x
 
 a
 
 n
 
 n_min
 
 n_max
 
 n_avg
 
 chi
 
 coeff
 
 n_recon
 
- Public Attributes inherited from warpy.post_processing.band_diagrams.density_profiles.Density1D
 x
 
 a
 
 n
 
 n_min
 
 n_max
 
 n_avg
 
 chi
 
 coeff
 
 n_recon
 
 N
 

Protected Member Functions

def _density_func (self)
 Not used as density vector is passed in at object initiation.
 
def _density_func (self, **density_kwargs)
 Populates density array with constant value.
 

Constructor & Destructor Documentation

◆ __init__()

def warpy.post_processing.band_diagrams.density_profiles.Density1DArb.__init__ (   self,
  x,
  n 
)

Calculates density profile attributes.

Parameters
xList of x values
nList of density values. Must be same size as x.

Reimplemented from warpy.post_processing.band_diagrams.density_profiles.Density1D.

Member Function Documentation

◆ _density_func()

def warpy.post_processing.band_diagrams.density_profiles.Density1DArb._density_func (   self)
protected

Not used as density vector is passed in at object initiation.

Reimplemented from warpy.post_processing.band_diagrams.density_profiles.Density1D.

Member Data Documentation

◆ a

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.a

◆ chi

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.chi

◆ coeff

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.coeff

◆ n

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.n

◆ n_avg

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.n_avg

◆ n_max

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.n_max

◆ n_min

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.n_min

◆ n_recon

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.n_recon

◆ x

warpy.post_processing.band_diagrams.density_profiles.Density1DArb.x

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