Classes | Public Member Functions | List of all members
Convergence Class Reference

Vlasov system convergence tester. More...

#include <convergence.hpp>

Classes

struct  EmitPoint

Public Member Functions

 Convergence ()
 Constructor for convergence class.
 ~Convergence ()
 Destructor for convergence class.
bool evaluate_iteration (void)
 Evaluate convergence of iteration round.
void print_history (std::ostream &os) const
 Print the history of convergence to stream.
void add_epot (const ScalarField &epot, double absf, double relf, double lim)
 Add electric potential to be followed.
void add_scharge (const ScalarField &scharge, double absf, double relf, double lim)
 Add space charge density to be followed.
void add_tdiag (const ParticleDataBase &pdb, coordinate_axis_e axis, double val, double absf, double relf, double lim)
 Add trajectory diagnostics to be followed.
void add_tdiag (const Emittance *emit1, double absf, double relf, double lim)
 Add trajectory diagnostics to be followed.
void add_tdiag (const Emittance *emit1, const Emittance *emit2, double absf, double relf, double lim)
 Add trajectory diagnostics to be followed.
void set_emittance (const Emittance *emit1, const Emittance *emit2=NULL)
 Set emittance for trajectory diagnostics.

Detailed Description

Vlasov system convergence tester.

Constructor & Destructor Documentation

Convergence::Convergence ( )

Constructor for convergence class.

Convergence::~Convergence ( )

Destructor for convergence class.

Member Function Documentation

void Convergence::add_epot ( const ScalarField epot,
double  absf,
double  relf,
double  lim 
)

Add electric potential to be followed.

void Convergence::add_scharge ( const ScalarField scharge,
double  absf,
double  relf,
double  lim 
)

Add space charge density to be followed.

void Convergence::add_tdiag ( const ParticleDataBase pdb,
coordinate_axis_e  axis,
double  val,
double  absf,
double  relf,
double  lim 
)

Add trajectory diagnostics to be followed.

void Convergence::add_tdiag ( const Emittance emit1,
double  absf,
double  relf,
double  lim 
)
inline

Add trajectory diagnostics to be followed.

void Convergence::add_tdiag ( const Emittance emit1,
const Emittance emit2,
double  absf,
double  relf,
double  lim 
)

Add trajectory diagnostics to be followed.

bool Convergence::evaluate_iteration ( void  )

Evaluate convergence of iteration round.

Increase iteration round counter and calculate convergence estimates for each followed feature. Returns true if convergence limits are reached. False is returned otherwise. Convergence estimates are saved to be analyzed. A summary is printed to cout if verbose printing is enabled.

void Convergence::print_history ( std::ostream &  os) const

Print the history of convergence to stream.

void Convergence::set_emittance ( const Emittance emit1,
const Emittance emit2 = NULL 
)

Set emittance for trajectory diagnostics.


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