Functor to compute electrostatic potential into mf_out. More...

#include <PhiFunctor.H>

Inheritance diagram for PhiFunctor:

Public Member Functions
	PhiFunctor (int lev, amrex::IntVect crse_ratio, bool convertRZmodes2cartesian=true, int ncomp=1)
	Constructor.

void	operator() (amrex::MultiFab &mf_dst, int dcomp, int) const override
	Compute phi directly into 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

Additional Inherited Members
Protected Attributes inherited from ComputeDiagFunctor
amrex::IntVect	m_crse_ratio

Detailed Description

Functor to compute electrostatic potential into mf_out.

Constructor & Destructor Documentation

PhiFunctor::PhiFunctor	(	int	lev,
		amrex::IntVect	crse_ratio,
		bool	convertRZmodes2cartesian = true,
		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]	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 phi 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 PhiFunctor::m_convertRZmodes2cartesian

private

int PhiFunctor::m_lev

private

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

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Diagnostics/ComputeDiagFunctors/PhiFunctor.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Diagnostics/ComputeDiagFunctors/PhiFunctor.cpp