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

#include <RhoFunctor.H>

Inheritance diagram for RhoFunctor:

Public Member Functions
	RhoFunctor (const int lev, const amrex::IntVect crse_ratio, const int species_index=-1, bool convertRZmodes2cartesian=true, const int ncomp=1)
	Constructor. More...

virtual void	operator() (amrex::MultiFab &mf_dst, const int dcomp, const 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

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 max_box_size, 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 ()

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	(	const int	lev,
		const amrex::IntVect	crse_ratio,
		const int	species_index = `-1`,
		bool	convertRZmodes2cartesian = `true`,
		const int	ncomp = `1`
	)

Constructor.

Parameters

[in]	lev	level of MultiFab
[in]	crse_ratio	coarsening ratio for interpolation of field values from simulation MultiFabs to the output MultiFab mf_dst
[in]	species_index	Index of species to dump rho per species. This argument is optional and defaults to -1 (dump total rho)
[in]	convertRZmodes2cartesian	if true, all RZ modes are averaged into one component
[in]	ncomp	optional number of component of source MultiFab mf_src to be cell-centered in output MultiFab mf_dst

overridevirtual

Compute rho directly into mf_dst.

Parameters

[out]	mf_dst	output MultiFab where the result is written
[in]	dcomp	first component of mf_dst in which cell-centered data are stored

bool RhoFunctor::m_convertRZmodes2cartesian

private

int const RhoFunctor::m_lev

private

const int RhoFunctor::m_species_index

private

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

/home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Diagnostics/ComputeDiagFunctors/RhoFunctor.H
/home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Diagnostics/ComputeDiagFunctors/RhoFunctor.cpp