FieldAccessorMacroscopic Struct Reference

Functor that returns the division of the source m_field Array4 value by macroparameter obtained using m_parameter, at the respective (i,j,k). More...

#include <FieldAccessorFunctors.H>

Public Member Functions
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE	FieldAccessorMacroscopic (amrex::Array4< amrex::Real const > const a_field, amrex::Array4< amrex::Real > const &a_parameter)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	operator() (int const i, int const j, int const k, int const ncomp) const noexcept
	return field value at (i,j,k,ncomp) scaled by (1/m_getParameter(x,y,z))

Private Attributes
amrex::Array4< amrex::Real const >	m_field
amrex::Array4< amrex::Real const >	m_parameter

Detailed Description

Functor that returns the division of the source m_field Array4 value by macroparameter obtained using m_parameter, at the respective (i,j,k).

Constructor & Destructor Documentation

FieldAccessorMacroscopic()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE FieldAccessorMacroscopic::FieldAccessorMacroscopic ( amrex::Array4< amrex::Real const > const a_field, amrex::Array4< amrex::Real > const & a_parameter )

inline

Member Function Documentation

operator()()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real FieldAccessorMacroscopic::operator() ( int const i, int const j, int const k, int const ncomp ) const

inlinenoexcept

return field value at (i,j,k,ncomp) scaled by (1/m_getParameter(x,y,z))

Parameters

[in]	i	index along x of the Array4, m_field and m_parameter.
[in]	j	index along y of the Array4, m_field and m_parameter.
[in]	k	index along z of the Array4, m_field and m_parameter.
[in]	ncomp	index along fourth component of the Array4, containing field-data to be returned after dividing by the macroparameter.

Returns

m_field/m_getParameter(x,y,z) at (i,j,k,ncomp)

Member Data Documentation

m_field

amrex::Array4<amrex::Real const> FieldAccessorMacroscopic::m_field

private

Array4 of the source field to be scaled and returned by the operator()

m_parameter

amrex::Array4<amrex::Real const> FieldAccessorMacroscopic::m_parameter

private

Array4 of the macroscopic parameter used to divide m_field in the operator()

---

The documentation for this struct was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6368/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/FieldAccessorFunctors.H