Public Member Functions | Private Attributes | List of all members
oomph::DocLinearSolverInfo Class Reference

Collection of data structures for storing information about linear solves. Currently only contains storage for the iteration counts and the linear solver time. More...

#include <oomph_utilities.h>

Public Member Functions

 DocLinearSolverInfo ()
 Constructor. Initialised the Iterations_and_times vector of vector of pairs. More...
 
void setup_new_time_step ()
 Set up a new vector of pairs for a new time step. More...
 
void clear_current_time_step ()
 
void add_iteration_and_time (unsigned iter, double prec_setup_time, double linear_solver_time)
 Add a new iteration and time pair. More...
 
unsigned current_ntime_step () const
 The number of time steps. More...
 
unsigned current_nnewton_step () const
 The number of Newton steps. More...
 
Vector< Vector< Vector< double > > > & iterations_and_times ()
 Accessor function for the iteration and times. More...
 
Vector< Vector< Vector< double > > > iterations_and_times () const
 Accessor function for the iteration and times (const version). More...
 

Private Attributes

Vector< Vector< Vector< double > > > Iterations_and_times
 Storage for number of iterations during Newton steps. More...
 

Detailed Description

Collection of data structures for storing information about linear solves. Currently only contains storage for the iteration counts and the linear solver time.

Definition at line 441 of file oomph_utilities.h.

Constructor & Destructor Documentation

oomph::DocLinearSolverInfo::DocLinearSolverInfo ( )
inline

Constructor. Initialised the Iterations_and_times vector of vector of pairs.

Definition at line 448 of file oomph_utilities.h.

Member Function Documentation

void oomph::DocLinearSolverInfo::add_iteration_and_time ( unsigned  iter,
double  prec_setup_time,
double  linear_solver_time 
)
inline

Add a new iteration and time pair.

Definition at line 467 of file oomph_utilities.h.

void oomph::DocLinearSolverInfo::clear_current_time_step ( )
inline

Definition at line 459 of file oomph_utilities.h.

unsigned oomph::DocLinearSolverInfo::current_nnewton_step ( ) const
inline

The number of Newton steps.

Definition at line 492 of file oomph_utilities.h.

unsigned oomph::DocLinearSolverInfo::current_ntime_step ( ) const
inline

The number of time steps.

Definition at line 488 of file oomph_utilities.h.

Vector<Vector<Vector<double> > >& oomph::DocLinearSolverInfo::iterations_and_times ( )
inline

Accessor function for the iteration and times.

Definition at line 496 of file oomph_utilities.h.

Vector<Vector<Vector<double> > > oomph::DocLinearSolverInfo::iterations_and_times ( ) const
inline

Accessor function for the iteration and times (const version).

Definition at line 500 of file oomph_utilities.h.

void oomph::DocLinearSolverInfo::setup_new_time_step ( )
inline

Set up a new vector of pairs for a new time step.

Definition at line 452 of file oomph_utilities.h.

Member Data Documentation

Vector<Vector<Vector<double> > > oomph::DocLinearSolverInfo::Iterations_and_times
private

Storage for number of iterations during Newton steps.

Definition at line 506 of file oomph_utilities.h.


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