oomph::DocLinearSolverInfo Class Reference

#include <oomph_utilities.h>

Public Member Functions
	DocLinearSolverInfo ()
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.

Constructor & Destructor Documentation

DocLinearSolverInfo()

oomph::DocLinearSolverInfo::DocLinearSolverInfo ( )

inline

Constructor. Initialised the Iterations_and_times vector of vector of pairs.

: Iterations_and_times() {}

Member Function Documentation

add_iteration_and_time()

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.

    {
#ifdef PARANOID
      if (Iterations_and_times.size() == 0)
      {
        std::ostringstream error_message;
        error_message << "Iterations_and_times is empty. "
                      << "Call setup_new_time_step()\n";
        throw OomphLibError(error_message.str(),
                            OOMPH_CURRENT_FUNCTION,
                            OOMPH_EXCEPTION_LOCATION);
      }
#endif
      Vector<double> tmp_iter_time_vec(3, 0);
      tmp_iter_time_vec[0] = (double)iter;
      tmp_iter_time_vec[1] = prec_setup_time;
      tmp_iter_time_vec[2] = linear_solver_time;
      Iterations_and_times.back().push_back(tmp_iter_time_vec);
    }

References OOMPH_CURRENT_FUNCTION, and OOMPH_EXCEPTION_LOCATION.

clear_current_time_step()

void oomph::DocLinearSolverInfo::clear_current_time_step ( )

inline

    {
      Iterations_and_times.pop_back();
      setup_new_time_step();
    }

current_nnewton_step()

unsigned oomph::DocLinearSolverInfo::current_nnewton_step ( ) const

inline

The number of Newton steps.

    {
      return Iterations_and_times.back().size();
    }

current_ntime_step()

unsigned oomph::DocLinearSolverInfo::current_ntime_step ( ) const

inline

The number of time steps.

    {
      return Iterations_and_times.size();
    }

iterations_and_times() [1/2]

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

inline

Accessor function for the iteration and times.

    {
      return Iterations_and_times;
    }

iterations_and_times() [2/2]

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

inline

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

    {
      return Iterations_and_times;
    }

setup_new_time_step()

void oomph::DocLinearSolverInfo::setup_new_time_step ( )

inline

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

    {
      // For each new time step, we have a new vector consisting of pairs of
      // unsigned (for the iteration) and double (for the timing results).
      Iterations_and_times.push_back(Vector<Vector<double>>());
    }

Member Data Documentation

Iterations_and_times

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

private

Storage for number of iterations during Newton steps.

---

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

• oomph_utilities.h