oomph::PicardConvergenceData Class Reference

Object that collates convergence data of Picard iteration. More...

#include <segregated_fsi_solver.h>

Public Member Functions
	PicardConvergenceData ()
	Constructor initialises all data. More...
	~PicardConvergenceData ()
	Empty destructor. More...
unsigned &	niter ()
	Number of iterations performed. More...
double &	cpu_total ()
	Total CPU time for segregated solve. More...
double &	essential_cpu_total ()
double &	cpu_for_global_residual ()
double &	tol_achieved ()
	Final tolerance achieved by the iteration. More...
bool	has_converged () const
	Flag to indicate if the solver has converged. More...
void	set_solver_converged ()
	Set the flag to indicate that the solver has converged. More...
void	set_solver_not_converged ()
	Set the flag to indicate that the solver has not converged. More...

Private Attributes
unsigned	Niter
	Number of iterations performed. More...
double	CPU_total
	Total CPU time for segregated solve. More...
double	Essential_cpu_total
double	CPU_for_global_residual
double	Tol_achieved
	Final tolerance achieved by the iteration. More...
bool	Has_converged
	Flag to indicate if the solver has converged. More...

Detailed Description

Object that collates convergence data of Picard iteration.

Constructor & Destructor Documentation

PicardConvergenceData()

oomph::PicardConvergenceData::PicardConvergenceData ( )

inline

Constructor initialises all data.

      : Niter(0),
        CPU_total(0.0),
        Essential_cpu_total(0.0),
        CPU_for_global_residual(0.0),
        Tol_achieved(0.0),
        Has_converged(false)
    {
    }

~PicardConvergenceData()

oomph::PicardConvergenceData::~PicardConvergenceData ( )

inline

Empty destructor.

{};

Member Function Documentation

cpu_for_global_residual()

double& oomph::PicardConvergenceData::cpu_for_global_residual ( )

inline

CPU time for computation of global residual vectors Note: This time is contained in Total_CPU and is only used if convergence is based on the residual of the fully coupled system.

    {
      return CPU_for_global_residual;
    }

References CPU_for_global_residual.

Referenced by main(), oomph::SegregatableFSIProblem::segregated_solve(), SegregatedFSICollapsibleChannelProblem< ELEMENT >::steady_run(), and SegregatedFSICollapsibleChannelProblem< ELEMENT >::unsteady_run().

cpu_total()

double& oomph::PicardConvergenceData::cpu_total ( )

inline

Total CPU time for segregated solve.

    {
      return CPU_total;
    }

References CPU_total.

Referenced by main(), oomph::SegregatableFSIProblem::segregated_solve(), SegregatedFSICollapsibleChannelProblem< ELEMENT >::steady_run(), and SegregatedFSICollapsibleChannelProblem< ELEMENT >::unsteady_run().

essential_cpu_total()

double& oomph::PicardConvergenceData::essential_cpu_total ( )

inline

Total essential CPU time for segregated solve (excluding any actions that merely doc the progress of the iteration, etc.)

    {
      return Essential_cpu_total;
    }

References Essential_cpu_total.

Referenced by main(), oomph::SegregatableFSIProblem::segregated_solve(), SegregatedFSICollapsibleChannelProblem< ELEMENT >::steady_run(), and SegregatedFSICollapsibleChannelProblem< ELEMENT >::unsteady_run().

has_converged()

bool oomph::PicardConvergenceData::has_converged ( ) const

inline

Flag to indicate if the solver has converged.

    {
      return Has_converged;
    }

References Has_converged.

niter()

unsigned& oomph::PicardConvergenceData::niter ( )

inline

Number of iterations performed.

    {
      return Niter;
    }

References Niter.

Referenced by oomph::SegregatableFSIProblem::segregated_solve(), SegregatedFSICollapsibleChannelProblem< ELEMENT >::steady_run(), and SegregatedFSICollapsibleChannelProblem< ELEMENT >::unsteady_run().

set_solver_converged()

void oomph::PicardConvergenceData::set_solver_converged ( )

inline

Set the flag to indicate that the solver has converged.

    {
      Has_converged = true;
    }

References Has_converged.

Referenced by oomph::SegregatableFSIProblem::segregated_solve().

set_solver_not_converged()

void oomph::PicardConvergenceData::set_solver_not_converged ( )

inline

Set the flag to indicate that the solver has not converged.

    {
      Has_converged = false;
    }

References Has_converged.

tol_achieved()

double& oomph::PicardConvergenceData::tol_achieved ( )

inline

Final tolerance achieved by the iteration.

    {
      return Tol_achieved;
    }

References Tol_achieved.

Referenced by oomph::SegregatableFSIProblem::segregated_solve().

Member Data Documentation

CPU_for_global_residual

double oomph::PicardConvergenceData::CPU_for_global_residual

private

CPU time for computation of global residual vectors Note: This time is contained in Total_CPU and is only used if convergence is based on the residual of the fully coupled system

Referenced by cpu_for_global_residual().

CPU_total

double oomph::PicardConvergenceData::CPU_total

private

Total CPU time for segregated solve.

Referenced by cpu_total().

Essential_cpu_total

double oomph::PicardConvergenceData::Essential_cpu_total

private

Total essential CPU time for segregated solve (excluding any actions that merely doc the progress of the iteration, etc.)

Referenced by essential_cpu_total().

Has_converged

bool oomph::PicardConvergenceData::Has_converged

private

Flag to indicate if the solver has converged.

Referenced by has_converged(), set_solver_converged(), and set_solver_not_converged().

Niter

unsigned oomph::PicardConvergenceData::Niter

private

Number of iterations performed.

Referenced by niter().

Tol_achieved

double oomph::PicardConvergenceData::Tol_achieved

private

Final tolerance achieved by the iteration.

Referenced by tol_achieved().

---

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

• segregated_fsi_solver.h