Inheritance diagram for ParticleEnergy:

Public Member Functions
	ParticleEnergy (std::string rd_name)

virtual void	ComputeDiags (int step) override final

Public Member Functions inherited from ReducedDiags
	ReducedDiags (std::string rd_name)

virtual	~ReducedDiags ()=default

virtual void	WriteToFile (int step) const

Additional Inherited Members
Public Attributes inherited from ReducedDiags
std::string	m_path = "./diags/reducedfiles/"
	output path (default) More...

std::string	m_extension = "txt"
	output extension (default) More...

std::string	m_rd_name
	diags name More...

IntervalsParser	m_intervals
	output frequency More...

int	m_IsNotRestart = 1
	check if it is a restart run More...

std::string	m_sep = " "
	separator in the output file More...

std::vector< amrex::Real >	m_data
	output data More...

Detailed Description

This class mainly contains a function that computes the particle relativistic kinetic energy of each species.

Constructor & Destructor Documentation

ParticleEnergy::ParticleEnergy ( std::string rd_name )

constructor

Parameters

[in] rd_name reduced diags names

void ParticleEnergy::ComputeDiags ( int step )

finaloverridevirtual

This funciton computes the particle relativistic kinetic energy (EP).

Parameters

[in] step current time step EP = sqrt( p^2 c^2 + m^2 c^4 ) - m c^2, where p is the relativistic momentum, m is the particle rest mass.

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

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/20.10/Source/Diagnostics/ReducedDiags/ParticleEnergy.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/20.10/Source/Diagnostics/ReducedDiags/ParticleEnergy.cpp