#include <solverdiagnostics.h>

Inheritance diagram for SolverDiagnostics:

Collaboration diagram for SolverDiagnostics:

Public Member Functions
	SolverDiagnostics (unsigned OF=OUTPUT_DEFAULT, DriveCaller *pOM=0)

virtual	~SolverDiagnostics (void)

void	SetNoOutput (void)

void	SetOutputMeter (DriveCaller *pOM)

void	SetOutputDriveHandler (const DriveHandler *pDH)

void	SetOutputFlags (unsigned OF)

void	AddOutputFlags (unsigned OF)

void	DelOutputFlags (unsigned OF)

MatrixHandler::Norm_t	GetCondMatNorm (void) const

bool	outputMeter (void) const

bool	outputIters (void) const

bool	outputRes (void) const

bool	outputSol (void) const

bool	outputJac (void) const

bool	outputStep (void) const

bool	outputBailout (void) const

bool	outputCounter (void) const

bool	outputMatrixConditionNumber (void) const

bool	outputSolverConditionNumber (void) const

bool	outputSolverConditionStat (void) const

bool	outputCPUTime (void) const

bool	outputMsg (void) const

Protected Types
enum	{ OUTPUT_NONE = 0x0000, OUTPUT_ITERS = 0x0001, OUTPUT_RES = 0x0002, OUTPUT_SOL = 0x0004, OUTPUT_JAC = 0x0008, OUTPUT_BAILOUT = 0x0010, OUTPUT_MSG = 0x0020, OUTPUT_COUNTER = 0x0040, OUTPUT_MAT_COND_NUM_1 = 0x0080, OUTPUT_MAT_COND_NUM_INF = 0x0100, OUTPUT_SOLVER_COND_NUM = 0x0200, OUTPUT_SOLVER_COND_STAT = 0x400, OUTPUT_CPU_TIME = 0x800, OUTPUT_MAT_COND_NUM = OUTPUT_MAT_COND_NUM_1 \| OUTPUT_MAT_COND_NUM_INF, OUTPUT_DEFAULT = OUTPUT_MSG, OUTPUT_STEP = (OUTPUT_ITERS \| OUTPUT_RES \| OUTPUT_SOL \| OUTPUT_JAC \| OUTPUT_MAT_COND_NUM \| OUTPUT_SOLVER_COND_NUM), OUTPUT_MASK = 0x07FF }

Protected Attributes
unsigned	OutputFlags

DriveCaller *	pOutputMeter

Detailed Description

Definition at line 38 of file solverdiagnostics.h.

Member Enumeration Documentation

anonymous enum

protected

Enumerator
OUTPUT_NONE
OUTPUT_ITERS
OUTPUT_RES
OUTPUT_SOL
OUTPUT_JAC
OUTPUT_BAILOUT
OUTPUT_MSG
OUTPUT_COUNTER
OUTPUT_MAT_COND_NUM_1
OUTPUT_MAT_COND_NUM_INF
OUTPUT_SOLVER_COND_NUM
OUTPUT_SOLVER_COND_STAT
OUTPUT_CPU_TIME
OUTPUT_MAT_COND_NUM
OUTPUT_DEFAULT
OUTPUT_STEP
OUTPUT_MASK

Definition at line 43 of file solverdiagnostics.h.

              {
                 OUTPUT_NONE             = 0x0000,
 
                 OUTPUT_ITERS            = 0x0001,
                 OUTPUT_RES              = 0x0002,
                 OUTPUT_SOL              = 0x0004,
                 OUTPUT_JAC              = 0x0008,
 
                 OUTPUT_BAILOUT          = 0x0010,
                 OUTPUT_MSG              = 0x0020,
                 OUTPUT_COUNTER          = 0x0040,
                 OUTPUT_MAT_COND_NUM_1 = 0x0080,
                 OUTPUT_MAT_COND_NUM_INF = 0x0100,
                 OUTPUT_SOLVER_COND_NUM = 0x0200,
                 OUTPUT_SOLVER_COND_STAT = 0x400,
                 OUTPUT_CPU_TIME         = 0x800,
                 OUTPUT_MAT_COND_NUM = OUTPUT_MAT_COND_NUM_1 | OUTPUT_MAT_COND_NUM_INF,
                 OUTPUT_DEFAULT          = OUTPUT_MSG,
                 OUTPUT_STEP             = (OUTPUT_ITERS | OUTPUT_RES | OUTPUT_SOL | OUTPUT_JAC | OUTPUT_MAT_COND_NUM | OUTPUT_SOLVER_COND_NUM),
 
                 OUTPUT_MASK             = 0x07FF
         };

Constructor & Destructor Documentation

SolverDiagnostics::SolverDiagnostics	(	unsigned	OF = `OUTPUT_DEFAULT`,
		DriveCaller *	pOM = `0`
	)

Definition at line 37 of file solverdiagnostics.cc.

References SetOutputFlags().

 : pOutputMeter(pOM)
 {
         SetOutputFlags(OF);
 }

Here is the call graph for this function:

SolverDiagnostics::~SolverDiagnostics ( void )

virtual

Definition at line 43 of file solverdiagnostics.cc.

References SetOutputFlags(), and SetOutputMeter().

 {
         SetOutputFlags(0);
         SetOutputMeter(0);
 }

Here is the call graph for this function:

Member Function Documentation

void SolverDiagnostics::AddOutputFlags ( unsigned OF )

Definition at line 80 of file solverdiagnostics.cc.

References OutputFlags.

Referenced by InverseSolver::ReadData(), and Solver::ReadData().

 {
         OutputFlags |= OF;
 }

void SolverDiagnostics::DelOutputFlags ( unsigned OF )

Definition at line 86 of file solverdiagnostics.cc.

References OutputFlags.

Referenced by Solver::ReadData().

 {
         OutputFlags &= ~OF;
 }

MatrixHandler::Norm_t SolverDiagnostics::GetCondMatNorm ( void ) const

inline

Definition at line 136 of file solverdiagnostics.h.

References ASSERT, MBDYN_EXCEPT_ARGS, MatrixHandler::NORM_1, MatrixHandler::NORM_INF, OUTPUT_MAT_COND_NUM, OUTPUT_MAT_COND_NUM_1, OUTPUT_MAT_COND_NUM_INF, and OutputFlags.

Referenced by LineSearchSolver::Jacobian(), and NewtonRaphsonSolver::Solve().

 {
         switch (OutputFlags & OUTPUT_MAT_COND_NUM) {
                 case OUTPUT_MAT_COND_NUM_1:
                         return MatrixHandler::NORM_1;
                 case OUTPUT_MAT_COND_NUM_INF:
                         return MatrixHandler::NORM_INF;
                 default:
                         ASSERT(0);
                         throw ErrGeneric(MBDYN_EXCEPT_ARGS);
         }
 }

bool SolverDiagnostics::outputBailout ( void ) const

inline

Definition at line 104 of file solverdiagnostics.h.

References OUTPUT_BAILOUT, and OutputFlags.

Referenced by BiCGStab::Solve(), NewtonRaphsonSolver::Solve(), Gmres::Solve(), and LineSearchSolver::Solve().

                                               {
                 // NOTE: this is NOT conditioned by output meter
                 return (OutputFlags & OUTPUT_BAILOUT);
         };

bool SolverDiagnostics::outputCounter ( void ) const

inline

Definition at line 109 of file solverdiagnostics.h.

References OUTPUT_COUNTER, and OutputFlags.

Referenced by Solver::Advance(), InverseSolver::Prepare(), Solver::Prepare(), and Solver::Start().

                                               {
                 return (OutputFlags & OUTPUT_COUNTER);
         };

bool SolverDiagnostics::outputCPUTime ( void ) const

inline

Definition at line 125 of file solverdiagnostics.h.

References OUTPUT_CPU_TIME, and OutputFlags.

Referenced by NewtonRaphsonSolver::Solve(), and LineSearchSolver::Solve().

                                               {
                 return (OutputFlags & OUTPUT_CPU_TIME);
         }

bool SolverDiagnostics::outputIters ( void ) const

inline

Definition at line 84 of file solverdiagnostics.h.

References OUTPUT_ITERS, OutputFlags, and outputMeter().

Referenced by DataManager::InitialJointAssembly(), LineSearchSolver::LineSearch(), BiCGStab::Solve(), NewtonRaphsonSolver::Solve(), Gmres::Solve(), and LineSearchSolver::Solve().

                                             {
                 return outputMeter() && (OutputFlags & OUTPUT_ITERS);
         };

Here is the call graph for this function:

bool SolverDiagnostics::outputJac ( void ) const

inline

Definition at line 96 of file solverdiagnostics.h.

References OUTPUT_JAC, OutputFlags, and outputMeter().

Referenced by InverseDynamicsStepSolver::Advance(), DataManager::InitialJointAssembly(), LineSearchSolver::Jacobian(), and NewtonRaphsonSolver::Solve().

                                           {
                 return outputMeter() && (OutputFlags & OUTPUT_JAC);
         };

Here is the call graph for this function:

bool SolverDiagnostics::outputMatrixConditionNumber ( void ) const

inline

Definition at line 113 of file solverdiagnostics.h.

References OUTPUT_MAT_COND_NUM, and OutputFlags.

Referenced by LineSearchSolver::Jacobian(), and NewtonRaphsonSolver::Solve().

                                                             {
                 return (OutputFlags & OUTPUT_MAT_COND_NUM);
         };

bool SolverDiagnostics::outputMeter ( void ) const

inline

Definition at line 80 of file solverdiagnostics.h.

References DriveCaller::dGet(), and pOutputMeter.

Referenced by outputIters(), outputJac(), outputRes(), outputSol(), and outputStep().

                                             {
                 return (!pOutputMeter || pOutputMeter->dGet());
         };

Here is the call graph for this function:

bool SolverDiagnostics::outputMsg ( void ) const

inline

Definition at line 131 of file solverdiagnostics.h.

References OUTPUT_MSG, and OutputFlags.

Referenced by InverseSolver::Advance(), Solver::Advance(), Solver::Prepare(), and Solver::Start().

                                           {
                 return (OutputFlags & OUTPUT_MSG);
         };

bool SolverDiagnostics::outputRes ( void ) const

inline

Definition at line 88 of file solverdiagnostics.h.

References OUTPUT_RES, OutputFlags, and outputMeter().

Referenced by InverseDynamicsStepSolver::Advance(), DataManager::InitialJointAssembly(), LineSearchSolver::Residual(), BiCGStab::Solve(), Gmres::Solve(), and NewtonRaphsonSolver::Solve().

                                           {
                 return outputMeter() && (OutputFlags & OUTPUT_RES);
         };

Here is the call graph for this function:

bool SolverDiagnostics::outputSol ( void ) const

inline

Definition at line 92 of file solverdiagnostics.h.

References OUTPUT_SOL, OutputFlags, and outputMeter().

Referenced by InverseDynamicsStepSolver::Advance(), DataManager::InitialJointAssembly(), BiCGStab::Solve(), NewtonRaphsonSolver::Solve(), Gmres::Solve(), and LineSearchSolver::Solve().

                                           {
                 return outputMeter() && (OutputFlags & OUTPUT_SOL);
         };

Here is the call graph for this function:

bool SolverDiagnostics::outputSolverConditionNumber ( void ) const

inline

Definition at line 117 of file solverdiagnostics.h.

References OUTPUT_SOLVER_COND_NUM, and OutputFlags.

Referenced by DataManager::InitialJointAssembly(), NewtonRaphsonSolver::Solve(), and LineSearchSolver::Solve().

                                                             {
                 return (OutputFlags & OUTPUT_SOLVER_COND_NUM);
         }

bool SolverDiagnostics::outputSolverConditionStat ( void ) const

inline

Definition at line 121 of file solverdiagnostics.h.

References OUTPUT_SOLVER_COND_STAT, and OutputFlags.

Referenced by NewtonRaphsonSolver::Solve(), and LineSearchSolver::Solve().

                                                           {
                 return (OutputFlags & OUTPUT_SOLVER_COND_STAT);
         }

bool SolverDiagnostics::outputStep ( void ) const

inline

Definition at line 100 of file solverdiagnostics.h.

References OUTPUT_STEP, OutputFlags, and outputMeter().

Referenced by InverseSolver::Advance(), Solver::Advance(), InverseSolver::Prepare(), Solver::Prepare(), and Solver::Start().

                                            {
                 return outputMeter() && (OutputFlags & OUTPUT_STEP);
         };

Here is the call graph for this function:

void SolverDiagnostics::SetNoOutput ( void )

Definition at line 50 of file solverdiagnostics.cc.

References OUTPUT_NONE, and OutputFlags.

Referenced by RTSolverBase::Init().

 {
         OutputFlags = OUTPUT_NONE;
 }

void SolverDiagnostics::SetOutputDriveHandler ( const DriveHandler * pDH )

Definition at line 66 of file solverdiagnostics.cc.

References pOutputMeter, and DriveCaller::SetDrvHdl().

Referenced by Solver::Prepare().

 {
         if (pOutputMeter) {
                 pOutputMeter->SetDrvHdl(pDH);
         }
 }

Here is the call graph for this function:

void SolverDiagnostics::SetOutputFlags ( unsigned OF )

Definition at line 74 of file solverdiagnostics.cc.

References OutputFlags.

Referenced by InverseSolver::Prepare(), Solver::Prepare(), InverseSolver::ReadData(), Solver::ReadData(), SolverDiagnostics(), and ~SolverDiagnostics().

 {
         OutputFlags = OF;
 }

void SolverDiagnostics::SetOutputMeter ( DriveCaller * pOM )

Definition at line 56 of file solverdiagnostics.cc.

References pOutputMeter.

Referenced by InverseSolver::Prepare(), Solver::Prepare(), InverseSolver::ReadData(), Solver::ReadData(), and ~SolverDiagnostics().

 {
         if (pOutputMeter) {
                 delete pOutputMeter;
         }
 
         pOutputMeter = pOM;
 }

Member Data Documentation

unsigned SolverDiagnostics::OutputFlags

protected

Definition at line 40 of file solverdiagnostics.h.

Referenced by AddOutputFlags(), DelOutputFlags(), GetCondMatNorm(), outputBailout(), outputCounter(), outputCPUTime(), outputIters(), outputJac(), outputMatrixConditionNumber(), outputMsg(), outputRes(), outputSol(), outputSolverConditionNumber(), outputSolverConditionStat(), outputStep(), InverseSolver::Prepare(), Solver::Prepare(), SetNoOutput(), and SetOutputFlags().

DriveCaller* SolverDiagnostics::pOutputMeter

protected

Definition at line 41 of file solverdiagnostics.h.

Referenced by outputMeter(), InverseSolver::Prepare(), Solver::Prepare(), SetOutputDriveHandler(), and SetOutputMeter().

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

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation