WarpX
Loading...
Searching...
No Matches
TemperatureFunctor Class Referencefinal

Functor to calculate per-cell averages of particle temperature. More...

#include <TemperatureFunctor.H>

Inheritance diagram for TemperatureFunctor:
ComputeDiagFunctor

Public Member Functions

 TemperatureFunctor (int lev, amrex::IntVect crse_ratio, int ispec, int ncomp=1)
 Constructor.
 
void operator() (amrex::MultiFab &mf_dst, int dcomp, int) const override
 Compute the temperature in each grid cell.
 
- Public Member Functions inherited from ComputeDiagFunctor
 ComputeDiagFunctor (int ncomp, amrex::IntVect crse_ratio)
 
virtual ~ComputeDiagFunctor ()=default
 
 ComputeDiagFunctor (const ComputeDiagFunctor &)=default
 
ComputeDiagFunctoroperator= (const ComputeDiagFunctor &)=default
 
 ComputeDiagFunctor (ComputeDiagFunctor &&)=default
 
ComputeDiagFunctoroperator= (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
 

Private Attributes

int m_lev
 
int m_ispec
 

Additional Inherited Members

- Protected Attributes inherited from ComputeDiagFunctor
amrex::IntVect m_crse_ratio
 

Detailed Description

Functor to calculate per-cell averages of particle temperature.

Constructor & Destructor Documentation

◆ TemperatureFunctor()

TemperatureFunctor::TemperatureFunctor ( int lev,
amrex::IntVect crse_ratio,
int ispec,
int ncomp = 1 )

Constructor.

Parameters
[in]levlevel of multifab
[in]crse_ratiofor interpolating field values from simulation MultiFabs to the output diagnostic MultiFab mf_dst
[in]ispecindex of the species over which to calculate the temperature
[in]ncompNumber of component of mf_src to cell-center in dst multifab

Member Function Documentation

◆ operator()()

void TemperatureFunctor::operator() ( amrex::MultiFab & mf_dst,
int dcomp,
int  ) const
overridevirtual

Compute the temperature in each grid cell.

Parameters
[out]mf_dstoutput MultiFab where the result is written
[in]dcompfirst component of mf_dst in which cell-centered data is stored

Implements ComputeDiagFunctor.

Member Data Documentation

◆ m_ispec

int TemperatureFunctor::m_ispec
private

index of species to average over

◆ m_lev

int TemperatureFunctor::m_lev
private

level on which mf_src is defined


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