SotSolver< dim, spacedim >::VerboseSolverControl Class Reference

A verbose solver control class that prints the progress of the solver. More...

Inheritance diagram for SotSolver< dim, spacedim >::VerboseSolverControl:

Collaboration diagram for SotSolver< dim, spacedim >::VerboseSolverControl:

Public Member Functions
	VerboseSolverControl (unsigned int n, double tol, bool use_componentwise, ConditionalOStream &pcout_)
void	set_gradient (const Vector< double > &grad)
void	set_target_measure (const Vector< double > &target_density, double user_tolerance)
virtual State	check (unsigned int step, double value) override
double	get_last_check_value () const

Private Attributes
ConditionalOStream &	pcout
bool	use_componentwise_check
double	initial_l1_norm = 1.0
const Vector< double > *	gradient
const Vector< double > *	target_measure
double	user_tolerance_for_componentwise
double	last_check_value = 0.0

Detailed Description

template<int dim, int spacedim = dim>
class SotSolver< dim, spacedim >::VerboseSolverControl

A verbose solver control class that prints the progress of the solver.

Definition at line 354 of file SotSolver.h.

Constructor & Destructor Documentation

VerboseSolverControl()

template<int dim, int spacedim = dim>

SotSolver< dim, spacedim >::VerboseSolverControl::VerboseSolverControl ( unsigned int  n, double  tol, bool  use_componentwise, ConditionalOStream &  pcout_  )

inline

Definition at line 357 of file SotSolver.h.

Member Function Documentation

set_gradient()

template<int dim, int spacedim = dim>

void SotSolver< dim, spacedim >::VerboseSolverControl::set_gradient ( const Vector< double > &  grad )

inline

Definition at line 366 of file SotSolver.h.

set_target_measure()

template<int dim, int spacedim = dim>

void SotSolver< dim, spacedim >::VerboseSolverControl::set_target_measure ( const Vector< double > &  target_density, double  user_tolerance  )

inline

Definition at line 370 of file SotSolver.h.

check()

template<int dim, int spacedim = dim>

virtual State SotSolver< dim, spacedim >::VerboseSolverControl::check ( unsigned int  step, double  value  )

inlineoverridevirtual

Definition at line 377 of file SotSolver.h.

get_last_check_value()

template<int dim, int spacedim = dim>

double SotSolver< dim, spacedim >::VerboseSolverControl::get_last_check_value ( ) const

inline

Definition at line 443 of file SotSolver.h.

Member Data Documentation

pcout

template<int dim, int spacedim = dim>

ConditionalOStream& SotSolver< dim, spacedim >::VerboseSolverControl::pcout

private

Definition at line 446 of file SotSolver.h.

use_componentwise_check

template<int dim, int spacedim = dim>

bool SotSolver< dim, spacedim >::VerboseSolverControl::use_componentwise_check

private

Definition at line 447 of file SotSolver.h.

initial_l1_norm

template<int dim, int spacedim = dim>

double SotSolver< dim, spacedim >::VerboseSolverControl::initial_l1_norm = 1.0

private

Definition at line 448 of file SotSolver.h.

gradient

template<int dim, int spacedim = dim>

const Vector<double>* SotSolver< dim, spacedim >::VerboseSolverControl::gradient

private

Definition at line 449 of file SotSolver.h.

target_measure

template<int dim, int spacedim = dim>

const Vector<double>* SotSolver< dim, spacedim >::VerboseSolverControl::target_measure

private

Definition at line 450 of file SotSolver.h.

user_tolerance_for_componentwise

template<int dim, int spacedim = dim>

double SotSolver< dim, spacedim >::VerboseSolverControl::user_tolerance_for_componentwise

private

Definition at line 451 of file SotSolver.h.

last_check_value

template<int dim, int spacedim = dim>

double SotSolver< dim, spacedim >::VerboseSolverControl::last_check_value = 0.0

private

Definition at line 452 of file SotSolver.h.

---

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

• include/SemiDiscreteOT/solvers/SotSolver.h