Convergence Class Reference

Vlasov system convergence follower. More...

#include <convergence.hpp>

Public Member Functions
	Convergence ()
	Constructor for convergence class. More...
	~Convergence ()
	Destructor for convergence class. More...
void	evaluate_iteration (void)
	Evaluate convergence of iteration round. More...
void	print_history (std::ostream &os) const
	Print the history of convergence to stream os. More...
void	add_epot (const MeshScalarField &epot)
	Add a reference to electric potential to be followed. More...
void	add_scharge (const MeshScalarField &scharge)
	Add a reference to space charge density to be followed. More...
void	add_emittance (uint32_t i, const Emittance &emit)
	Add a reference to emittance to be followed. More...
void	clear (void)
	Clear. More...

Detailed Description

Vlasov system convergence follower.

Constructor & Destructor Documentation

Convergence()

Convergence::Convergence

(

)

Constructor for convergence class.

~Convergence()

Convergence::~Convergence

(

)

Destructor for convergence class.

Member Function Documentation

add_emittance()

void Convergence::add_emittance	(	uint32_t	i,
		const Emittance &	emit
	)

Add a reference to emittance to be followed.

Multiple emittances can be followed. Emittances must be referenced with running numbers i starting from 0. Overwriting a definition is possible.

add_epot()

void Convergence::add_epot

(

const MeshScalarField &

epot

)

Add a reference to electric potential to be followed.

add_scharge()

void Convergence::add_scharge

(

const MeshScalarField &

scharge

)

Add a reference to space charge density to be followed.

clear()

void Convergence::clear

(

void

)

Clear.

Clears references to followed objects, clears history and clears iteration counter.

evaluate_iteration()

void Convergence::evaluate_iteration

(

void

)

Evaluate convergence of iteration round.

print_history()

void Convergence::print_history

(

std::ostream &

os

)

const

Print the history of convergence to stream os.

---

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

• convergence.hpp
• convergence.cpp