Functor to compute divB into mf_out. More...

Inheritance diagram for DivBFunctor:

Public Member Functions
	DivBFunctor (const std::array< const amrex::MultiFab *const, 3 > arr_mf_src, const int lev, amrex::IntVect crse_ratio, bool convertRZmodes2cartesian=true, const int ncomp=1)

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

Private Attributes
std::array< const amrex::MultiFab *const, 3 >	m_arr_mf_src

int const	m_lev

bool	m_convertRZmodes2cartesian

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

Detailed Description

Functor to compute divB into mf_out.

Constructor & Destructor Documentation

DivBFunctor::DivBFunctor	(	const std::array< const amrex::MultiFab *const, 3 >	arr_mf_src,
		const int	lev,
		amrex::IntVect	crse_ratio,
		bool	convertRZmodes2cartesian = `true`,
		const int	ncomp = `1`
	)

Constructor.

Parameters

[in]	arr_mf_src	source multifabs (3 elements for x y z).
[in]	lev	level of multifab.
[in]	crse_ratio	for interpolating field values from simulation MultiFabs to the output diagnostic MultiFab, mf_dst.
[in]	convertRZmodes2cartesian	whether to generate the result in Cartesian coordinates (summing over modes)
[in]	ncomp	Number of component of mf_src to cell-center in dst multifab.

overridevirtual

Compute DivB 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 is stored

std::array<const amrex::MultiFab * const, 3> DivBFunctor::m_arr_mf_src

private

Vector of pointer to source multifab Bx, By, Bz

bool DivBFunctor::m_convertRZmodes2cartesian

private

int const DivBFunctor::m_lev

private

level on which mf_src is defined (used in cylindrical) (for cylindrical) whether to average all modes into 1 comp

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/DivBFunctor.H
/home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Diagnostics/ComputeDiagFunctors/DivBFunctor.cpp