Functor that returns the division of the source m_field Array4 value by macroparameter, m_parameter value at the respective (i,j,k,ncomp).
More...
#include <FieldAccessorFunctors.H>
|
| AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE | FieldAccessorMacroscopic (amrex::Array4< amrex::Real const > const a_field, amrex::Array4< amrex::Real const > 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_parameters(i,j,k,ncomp)) More...
|
| |
|
| amrex::Array4< amrex::Real const > const | m_field |
| |
| amrex::Array4< amrex::Real const > const | m_parameter |
| |
Functor that returns the division of the source m_field Array4 value by macroparameter, m_parameter value at the respective (i,j,k,ncomp).
◆ FieldAccessorMacroscopic()
| AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE FieldAccessorMacroscopic::FieldAccessorMacroscopic |
( |
amrex::Array4< amrex::Real const > const |
a_field, |
|
|
amrex::Array4< amrex::Real const > const |
a_parameter |
|
) |
| |
|
inline |
◆ 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_parameters(i,j,k,ncomp))
- 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 diving with zero-th component of m_paramter. |
- Returns
- m_field/m_paramter at (i,j,k,ncomp)
◆ m_field
| amrex::Array4<amrex::Real const> 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> 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/20.10/Source/FieldSolver/FiniteDifferenceSolver/FiniteDifferenceAlgorithms/FieldAccessorFunctors.H
