WarpX
Public Member Functions | Private Attributes | List of all members
RhoFunctor Class Referencefinal

Functor to compute charge density rho into mf_out. More...

#include <RhoFunctor.H>

Inheritance diagram for RhoFunctor:
ComputeDiagFunctor

Public Member Functions

 RhoFunctor (int lev, amrex::IntVect crse_ratio, bool apply_rz_psatd_filter=false, int species_index=-1, bool convertRZmodes2cartesian=true, int ncomp=1)
 Constructor. More...
 
void operator() (amrex::MultiFab &mf_dst, int dcomp, int) const override
 Compute rho directly into mf_dst. More...
 
- Public Member Functions inherited from ComputeDiagFunctor
 ComputeDiagFunctor (int ncomp, amrex::IntVect crse_ratio)
 
virtual ~ComputeDiagFunctor ()=default
 
 ComputeDiagFunctor (const ComputeDiagFunctor &)=default
 
ComputeDiagFunctoroperator= (const ComputeDiagFunctor &)=default
 
 ComputeDiagFunctor (ComputeDiagFunctor &&)=default
 
ComputeDiagFunctoroperator= (ComputeDiagFunctor &&)=default
 
int nComp () const
 
virtual void PrepareFunctorData (int i_buffer, bool z_slice_in_domain, amrex::Real current_z_boost, amrex::Box buffer_box, const int k_index_zlab, const int snapshot_full)
 Prepare data required to process fields in the operator() Note that this function has parameters that are specific to back-transformed diagnostics, that are unused for regular diagnostics. More...
 
virtual void InitData ()
 
void InterpolateMFForDiag (amrex::MultiFab &mf_dst, const amrex::MultiFab &mf_src, int dcomp, const amrex::DistributionMapping &dm, bool convertRZmodes2cartesian) const
 

Private Attributes

int const m_lev
 
bool m_apply_rz_psatd_filter
 
const int m_species_index
 
bool m_convertRZmodes2cartesian
 

Additional Inherited Members

- Protected Attributes inherited from ComputeDiagFunctor
amrex::IntVect m_crse_ratio
 

Detailed Description

Functor to compute charge density rho into mf_out.

Constructor & Destructor Documentation

◆ RhoFunctor()

RhoFunctor::RhoFunctor ( int  lev,
amrex::IntVect  crse_ratio,
bool  apply_rz_psatd_filter = false,
int  species_index = -1,
bool  convertRZmodes2cartesian = true,
int  ncomp = 1 
)

Constructor.

Parameters
[in]levlevel of MultiFab
[in]crse_ratiocoarsening ratio for interpolation of field values from simulation MultiFabs to the output MultiFab mf_dst
[in]species_indexIndex of species to dump rho per species. This argument is optional and defaults to -1 (dump total rho)
[in]convertRZmodes2cartesianif true, all RZ modes are averaged into one component
[in]ncompoptional number of component of source MultiFab mf_src to be cell-centered in output MultiFab mf_dst

Member Function Documentation

◆ operator()()

void RhoFunctor::operator() ( amrex::MultiFab mf_dst,
int  dcomp,
int   
) const
overridevirtual

Compute rho directly into mf_dst.

Parameters
[out]mf_dstoutput MultiFab where the result is written
[in]dcompfirst component of mf_dst in which cell-centered data are stored

Implements ComputeDiagFunctor.

Member Data Documentation

◆ m_apply_rz_psatd_filter

bool RhoFunctor::m_apply_rz_psatd_filter
private

◆ m_convertRZmodes2cartesian

bool RhoFunctor::m_convertRZmodes2cartesian
private

◆ m_lev

int const RhoFunctor::m_lev
private

◆ m_species_index

const int RhoFunctor::m_species_index
private

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