FieldPoyntingFlux Class Reference

This class mainly contains a function that computes the field Poynting flux, S = E cross B, integrated over each face of the domain. More...

#include <FieldPoyntingFlux.H>

Inheritance diagram for FieldPoyntingFlux:

Public Member Functions
	FieldPoyntingFlux (const std::string &rd_name)
	Constructor.
void	ComputeDiags (int step) final
	Call the routine to compute the Poynting flux if needed.
void	ComputeDiagsMidStep (int step) final
	Call the routine to compute the Poynting flux at the mid step time level.
void	ComputePoyntingFlux ()
	This function computes the electromagnetic Poynting flux, obtained by integrating the electromagnetic Poynting flux density g = eps0 * (E x B) on the surface of the domain.
void	WriteCheckpointData (std::string const &dir) final
	Write out checkpoint related data.
void	ReadCheckpointData (std::string const &dir) final
	Read in checkpoint related data.
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	WriteToFile (int step) const
bool	DoDiags (int step) const
void	BackwardCompatibility () const

Private Attributes
bool	use_mid_step_value = false

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 mainly contains a function that computes the field Poynting flux, S = E cross B, integrated over each face of the domain.

Constructor & Destructor Documentation

FieldPoyntingFlux()

FieldPoyntingFlux::FieldPoyntingFlux

(

const std::string &

rd_name

)

Constructor.

Parameters

[in]

rd_name

reduced diags names

Member Function Documentation

ComputeDiags()

void FieldPoyntingFlux::ComputeDiags ( int step )

finalvirtual

Call the routine to compute the Poynting flux if needed.

Parameters

[in]

step

current time step

Implements ReducedDiags.

ComputeDiagsMidStep()

void FieldPoyntingFlux::ComputeDiagsMidStep ( int step )

finalvirtual

Call the routine to compute the Poynting flux at the mid step time level.

Parameters

[in]

step

current time step

Reimplemented from ReducedDiags.

ComputePoyntingFlux()

void FieldPoyntingFlux::ComputePoyntingFlux

(

)

This function computes the electromagnetic Poynting flux, obtained by integrating the electromagnetic Poynting flux density g = eps0 * (E x B) on the surface of the domain.

ReadCheckpointData()

void FieldPoyntingFlux::ReadCheckpointData ( std::string const & dir )

finalvirtual

Read in checkpoint related data.

Parameters

[in]

dir

Directory where checkpoint data was written

Reimplemented from ReducedDiags.

WriteCheckpointData()

void FieldPoyntingFlux::WriteCheckpointData ( std::string const & dir )

finalvirtual

Write out checkpoint related data.

Parameters

[in]

dir

Directory where checkpoint data is written

Reimplemented from ReducedDiags.

Member Data Documentation

use_mid_step_value

bool FieldPoyntingFlux::use_mid_step_value = false

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Diagnostics/ReducedDiags/FieldPoyntingFlux.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Diagnostics/ReducedDiags/FieldPoyntingFlux.cpp