WarpX
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
JFunctor Class Referencefinal

Functor to cell-center MF for current density and store result in mf_out. More...

#include <JFunctor.H>

Inheritance diagram for JFunctor:
ComputeDiagFunctor

Public Member Functions

 JFunctor (int dir, int lev, amrex::IntVect crse_ratio, bool convertRZmodes2cartesian=true, bool deposit_current=false, int ncomp=1)
 
void operator() (amrex::MultiFab &mf_dst, int dcomp, int) const override
 Cell-center m_mf_src and write the result in mf_dst.
 
- Public Member Functions inherited from ComputeDiagFunctor
 ComputeDiagFunctor (int ncomp, amrex::IntVect crse_ratio)
 
virtual ~ComputeDiagFunctor ()=default
 
 ComputeDiagFunctor (const ComputeDiagFunctor &)=default
 
ComputeDiagFunctor & operator= (const ComputeDiagFunctor &)=default
 
 ComputeDiagFunctor (ComputeDiagFunctor &&)=default
 
ComputeDiagFunctor & operator= (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.
 
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 m_dir
 
int m_lev
 
bool m_convertRZmodes2cartesian
 
bool m_deposit_current
 

Additional Inherited Members

- Protected Attributes inherited from ComputeDiagFunctor
amrex::IntVect m_crse_ratio
 

Detailed Description

Functor to cell-center MF for current density and store result in mf_out.

Constructor & Destructor Documentation

◆ JFunctor()

JFunctor::JFunctor ( int dir,
int lev,
amrex::IntVect crse_ratio,
bool convertRZmodes2cartesian = true,
bool deposit_current = false,
int ncomp = 1 )

Constructor.

Parameters
[in]dirdirection of vector field to operate on
[in]levlevel of multifab. Used for averaging in rz.
[in]crse_ratiofor interpolating field values from the simulation MultiFab, src_mf, to the output diagnostic MultiFab, mf_dst.
[in]convertRZmodes2cartesian(in cylindrical) whether to sum all modes in mf_src before cell-centering into dst multifab.
[in]deposit_currentwhether to deposit current. Used to output current in cases where no field solve is used.
[in]ncompNumber of component of mf_src to cell-center in dst multifab.

Member Function Documentation

◆ operator()()

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

Cell-center m_mf_src and write the result in mf_dst.

In cylindrical geometry, by default this functor average all components of a MultiFab and writes into one single component.

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

pointer to source multifab (can be multi-component)

Implements ComputeDiagFunctor.

Member Data Documentation

◆ m_convertRZmodes2cartesian

bool JFunctor::m_convertRZmodes2cartesian
private

(for cylindrical) whether to average all modes into 1 comp

◆ m_deposit_current

bool JFunctor::m_deposit_current
private

whether to deposit current density before saving

◆ m_dir

int JFunctor::m_dir
private

direction of the current density to save

◆ m_lev

int JFunctor::m_lev
private

level on which mf_src is defined

The documentation for this class was generated from the following files:
Generated by doxygen 1.13.2