WarpX
Public Member Functions | Public Attributes | List of all members
BeamRelevant Class Reference

#include <BeamRelevant.H>

Inheritance diagram for BeamRelevant:
ReducedDiags

Public Member Functions

 BeamRelevant (const std::string &rd_name)
 
void ComputeDiags (int step) final
 
- Public Member Functions inherited from ReducedDiags
 ReducedDiags (const std::string &rd_name)
 
virtual ~ReducedDiags ()=default
 
 ReducedDiags (const ReducedDiags &)=default
 
ReducedDiagsoperator= (const ReducedDiags &)=default
 
 ReducedDiags (ReducedDiags &&)=default
 
ReducedDiagsoperator= (ReducedDiags &&)=default
 
virtual void InitData ()
 
virtual void LoadBalance ()
 
virtual void WriteToFile (int step) const
 
void BackwardCompatibility () const
 

Public Attributes

std::string m_beam_name
 name of beam species More...
 
- 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...
 
utils::parser::IntervalsParser m_intervals
 output intervals More...
 
bool m_write_header = false
 check if header should be written More...
 
std::string m_sep = " "
 separator in the output file More...
 
int m_precision = 14
 precision for data in the output file More...
 
std::vector< amrex::Real > m_data
 output data More...
 

Detailed Description

This class contains diagnostics that are relevant to beam.

Constructor & Destructor Documentation

◆ BeamRelevant()

BeamRelevant::BeamRelevant ( const std::string &  rd_name)

constructor

Parameters
[in]rd_namereduced diags names

Member Function Documentation

◆ ComputeDiags()

void BeamRelevant::ComputeDiags ( int  step)
finalvirtual

This function computes beam relevant quantities.

Parameters
[in]stepcurrent time step

Implements ReducedDiags.

Member Data Documentation

◆ m_beam_name

std::string BeamRelevant::m_beam_name

name of beam species


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