ComputeParticleDiagFunctor Class Reference

Functor to compute a diagnostic and store the result in existing ParticleContainer. More...

#include <ComputeParticleDiagFunctor.H>

Inheritance diagram for ComputeParticleDiagFunctor:

Public Member Functions
	ComputeParticleDiagFunctor ()
virtual	~ComputeParticleDiagFunctor ()=default
virtual void	PrepareFunctorData (int i_buffer, bool ZSliceInDomain, amrex::Real old_z_boost, amrex::Real current_z_boost, amrex::Real t_lab, int snapshot_full)
	Prepare data required to back-transform particle attribtutes for lab-frame snapshot, with index i_buffer. Note that this function has parameters that are specific to back-transformed diagnostics, that are unused for regular diagnostics. More...
virtual void	operator() (PinnedMemoryParticleContainer &pc_dst, int &totalParticlesInBuffer, int i_buffer=0) const =0
virtual void	InitData ()

Detailed Description

Functor to compute a diagnostic and store the result in existing ParticleContainer.

Constructor & Destructor Documentation

ComputeParticleDiagFunctor()

ComputeParticleDiagFunctor::ComputeParticleDiagFunctor ( )

inline

~ComputeParticleDiagFunctor()

virtual ComputeParticleDiagFunctor::~ComputeParticleDiagFunctor ( )

virtualdefault

Virtual Destructor to handle clean destruction of derived classes

Member Function Documentation

InitData()

virtual void ComputeParticleDiagFunctor::InitData ( )

inlinevirtual

Reimplemented in BackTransformParticleFunctor.

operator()()

virtual void ComputeParticleDiagFunctor::operator() ( PinnedMemoryParticleContainer &  pc_dst, int &  totalParticlesInBuffer, int  i_buffer = 0  ) const

pure virtual

Compute particle attributes and store the result in pc_dst particle container.

Parameters

[out]	pc_dst	output particle container where the result is stored.
[out]	totalParticlesInBuffer	total number of particles in the container
[in]	i_buffer	snapshot index for which the particle buffer is processed

Implemented in BackTransformParticleFunctor.

PrepareFunctorData()

virtual void ComputeParticleDiagFunctor::PrepareFunctorData ( int  i_buffer, bool  ZSliceInDomain, amrex::Real  old_z_boost, amrex::Real  current_z_boost, amrex::Real  t_lab, int  snapshot_full  )

inlinevirtual

Prepare data required to back-transform particle attribtutes for lab-frame snapshot, with index i_buffer. Note that this function has parameters that are specific to back-transformed diagnostics, that are unused for regular diagnostics.

Parameters

[in]	i_buffer	index of the snapshot
[in]	ZSliceInDomain	if the z-slice at current_z_boost is within the bounds of the boosted-frame and lab-frame domain. The particles are transformed only if this value is true.
[in]	old_z_boost	old z co-ordinate of the slice selected in boosted-frame.
[in]	current_z_boost	z co-ordinate of the slice selected in boosted-frame.
[in]	t_lab	current time in lab-frame for snapshot, i_buffer.
[in]	snapshot_full	if the current snapshot, with index, i_buffer, is full (1) or not (0). If it is full, then Lorentz-transform is not performed by setting m_perform_backtransform to 0 for the corresponding ith snapshot.

Reimplemented in BackTransformParticleFunctor.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H