DifferentialLuminosity2D Class Reference

#include <DifferentialLuminosity2D.H>

Inheritance diagram for DifferentialLuminosity2D:

Public Member Functions
	DifferentialLuminosity2D (const std::string &rd_name)
void	ComputeDiags (int step) final
void	WriteToFile (int step) const final
Public Member Functions inherited from ReducedDiags
	ReducedDiags (const std::string &rd_name)
virtual	~ReducedDiags ()=default
	ReducedDiags (const ReducedDiags &)=default
ReducedDiags &	operator= (const ReducedDiags &)=default
	ReducedDiags (ReducedDiags &&)=default
ReducedDiags &	operator= (ReducedDiags &&)=default
virtual void	InitData ()
virtual void	LoadBalance ()
virtual void	ComputeDiagsMidStep (int step)
bool	DoDiags (int step) const
virtual void	WriteCheckpointData (std::string const &dir)
	Write out checkpoint related data.
virtual void	ReadCheckpointData (std::string const &dir)
	Read in checkpoint related data.
void	BackwardCompatibility () const

Public Attributes
std::string	m_openpmd_backend {"default"}
	File type.
int	m_file_min_digits = 6
	minimum number of digits for file suffix (file-based only supported for now) *‍/
std::vector< std::string >	m_beam_name
	name of the two colliding species
int	m_bin_num_1
	number of bins for the c.o.m. energy of the 2 species
int	m_bin_num_2
amrex::Real	m_bin_max_1
	max and min bin values
amrex::Real	m_bin_min_1
amrex::Real	m_bin_max_2
amrex::Real	m_bin_min_2
amrex::Real	m_bin_size_1
	bin size
amrex::Real	m_bin_size_2
amrex::TableData< amrex::Real, 2 >	m_h_data_2D
	output data
Public Attributes inherited from ReducedDiags
std::string	m_path = "./diags/reducedfiles/"
	output path (default)
std::string	m_extension = "txt"
	output extension (default)
std::string	m_rd_name
	diags name
utils::parser::IntervalsParser	m_intervals
	output intervals
bool	m_write_header = false
	check if header should be written
std::string	m_sep = " "
	separator in the output file
int	m_precision = 14
	precision for data in the output file
std::vector< amrex::Real >	m_data
	output data

Private Attributes
amrex::TableData< amrex::Real, 2 >	m_d_data_2D
	output table in which to accumulate the luminosity across timesteps

Detailed Description

This class contains the differential luminosity diagnostics.

Constructor & Destructor Documentation

DifferentialLuminosity2D()

DifferentialLuminosity2D::DifferentialLuminosity2D

(

const std::string &

rd_name

)

constructor

Parameters

[in]

rd_name

reduced diags names

Member Function Documentation

ComputeDiags()

void DifferentialLuminosity2D::ComputeDiags ( int step )

finalvirtual

function to compute diags

Parameters

[in]

step

current time step

Implements ReducedDiags.

WriteToFile()

void DifferentialLuminosity2D::WriteToFile ( int step ) const

finalvirtual

write to file function

Parameters

[in]

step

current time step

Reimplemented from ReducedDiags.

Member Data Documentation

m_beam_name

std::vector<std::string> DifferentialLuminosity2D::m_beam_name

name of the two colliding species

m_bin_max_1

amrex::Real DifferentialLuminosity2D::m_bin_max_1

max and min bin values

m_bin_max_2

amrex::Real DifferentialLuminosity2D::m_bin_max_2

m_bin_min_1

amrex::Real DifferentialLuminosity2D::m_bin_min_1

m_bin_min_2

amrex::Real DifferentialLuminosity2D::m_bin_min_2

m_bin_num_1

int DifferentialLuminosity2D::m_bin_num_1

number of bins for the c.o.m. energy of the 2 species

m_bin_num_2

int DifferentialLuminosity2D::m_bin_num_2

m_bin_size_1

amrex::Real DifferentialLuminosity2D::m_bin_size_1

bin size

m_bin_size_2

amrex::Real DifferentialLuminosity2D::m_bin_size_2

m_d_data_2D

amrex::TableData<amrex::Real,2> DifferentialLuminosity2D::m_d_data_2D

private

output table in which to accumulate the luminosity across timesteps

m_file_min_digits

int DifferentialLuminosity2D::m_file_min_digits = 6

minimum number of digits for file suffix (file-based only supported for now) *‍/

m_h_data_2D

amrex::TableData<amrex::Real,2> DifferentialLuminosity2D::m_h_data_2D

output data

m_openpmd_backend

std::string DifferentialLuminosity2D::m_openpmd_backend {"default"}

File type.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Diagnostics/ReducedDiags/DifferentialLuminosity2D.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Diagnostics/ReducedDiags/DifferentialLuminosity2D.cpp