Timestep Class Reference

#include <Timestep.H>

Inheritance diagram for Timestep:

Public Member Functions
	Timestep (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
ReducedDiags &	operator= (const ReducedDiags &)=default
	ReducedDiags (ReducedDiags &&)=default
ReducedDiags &	operator= (ReducedDiags &&)=default
virtual void	InitData ()
virtual void	LoadBalance ()
virtual void	ComputeDiagsMidStep (int step)
virtual void	WriteToFile (int step) const
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

Additional Inherited Members
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

Detailed Description

This class contains a function for retrieving the current simulation timestep as a diagnostic. Useful mainly for simulations using adaptive timestepping.

Constructor & Destructor Documentation

Timestep()

Timestep::Timestep

(

const std::string &

rd_name

)

constructor

Parameters

[in]

rd_name

reduced diags name

Member Function Documentation

ComputeDiags()

void Timestep::ComputeDiags ( int step )

finalvirtual

This function gets the current physical timestep of the simulation at all refinement levels.

Parameters

[in]

step

current time step

Implements ReducedDiags.

---

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

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