NonlinearSolver Class Reference

#include <nonlin.h>

Inheritance diagram for NonlinearSolver:

Collaboration diagram for NonlinearSolver:

Classes
class	ConvergenceOnSolution
class	ErrGeneric
class	ErrSimulationDiverged
class	MaxResidualExceeded
class	NoConvergence
class	TimeStepLimitExceeded

Public Types
enum	Type {   UNKNOWN = -1, NEWTONRAPHSON, MATRIXFREE, LINESEARCH,   DEFAULT = NEWTONRAPHSON, LASTSOLVERTYPE }

Public Member Functions
	NonlinearSolver (const NonlinearSolverOptions &options)
virtual void	SetTest (NonlinearSolverTest *pr, NonlinearSolverTest *ps)
virtual	~NonlinearSolver (void)
virtual bool	MakeResTest (Solver *pS, const NonlinearProblem *pNLP, const VectorHandler &Vec, const doublereal &dTol, doublereal &dTest, doublereal &dTestDiff)
virtual void	Solve (const NonlinearProblem *pNLP, Solver *pS, const integer iMaxIter, const doublereal &Tol, integer &iIterCnt, doublereal &dErr, const doublereal &SolTol, doublereal &dSolErr)=0
virtual integer	TotalAssembledJacobian (void)
virtual NonlinearSolverTest *	pGetResTest (void)
virtual NonlinearSolverTest *	pGetSolTest (void)
Public Member Functions inherited from SolverDiagnostics
	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	CPUTimeType { CPU_RESIDUAL, CPU_JACOBIAN, CPU_LINEAR_SOLVER, CPU_LAST_TYPE }
Protected Types inherited from SolverDiagnostics
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 Types inherited from NonlinearSolverOptions
enum	ScaleFlags { SCALE_ALGEBRAIC_EQUATIONS_NO = 0, SCALE_ALGEBRAIC_EQUATIONS_YES = 1 }

Protected Member Functions
virtual bool	MakeSolTest (Solver *pS, const VectorHandler &Vec, const doublereal &dTol, doublereal &dTest)
doublereal	dGetCondMax () const
doublereal	dGetCondMin () const
doublereal	dGetCondAvg () const
doublereal	dGetTimeCPU (CPUTimeType eType) const
void	AddCond (doublereal dCond)
void	AddTimeCPU (doublereal dTime, CPUTimeType eType)
Protected Member Functions inherited from NonlinearSolverOptions
	NonlinearSolverOptions (bool bHonorJacRequest=false, enum ScaleFlags eScaleFlags=SCALE_ALGEBRAIC_EQUATIONS_NO, doublereal dScaleAlgebraic=1.)

Protected Attributes
integer	Size
integer	TotJac
NonlinearSolverTest *	pResTest
NonlinearSolverTest *	pSolTest
Protected Attributes inherited from SolverDiagnostics
unsigned	OutputFlags
DriveCaller *	pOutputMeter
Protected Attributes inherited from NonlinearSolverOptions
bool	bHonorJacRequest
enum NonlinearSolverOptions::ScaleFlags	eScaleFlags
doublereal	dScaleAlgebraic

Private Attributes
integer	iNumCond
doublereal	dMaxCond
doublereal	dMinCond
doublereal	dSumCond
doublereal	dTimeCPU [CPU_LAST_TYPE]

Detailed Description

Definition at line 211 of file nonlin.h.

Member Enumeration Documentation

enum NonlinearSolver::CPUTimeType

protected

Enumerator
CPU_RESIDUAL
CPU_JACOBIAN
CPU_LINEAR_SOLVER
CPU_LAST_TYPE

Definition at line 268 of file nonlin.h.

                         {
                CPU_RESIDUAL,
                CPU_JACOBIAN,
                CPU_LINEAR_SOLVER,
                CPU_LAST_TYPE
        };

enum NonlinearSolver::Type

Enumerator
UNKNOWN
NEWTONRAPHSON
MATRIXFREE
LINESEARCH
DEFAULT
LASTSOLVERTYPE

Definition at line 239 of file nonlin.h.

                  {
                UNKNOWN = -1,

                NEWTONRAPHSON,
                MATRIXFREE,
                LINESEARCH,
                DEFAULT = NEWTONRAPHSON,

                LASTSOLVERTYPE
        };

Constructor & Destructor Documentation

NonlinearSolver::NonlinearSolver ( const NonlinearSolverOptions &  options )

explicit

Definition at line 434 of file nonlin.cc.

References dTimeCPU.

: NonlinearSolverOptions(options),
Size(0),
TotJac(0),
#ifdef USE_MPI
bParallel(MPI::Is_initialized()),
#endif /* USE_MPI */
pResTest(0),
pSolTest(0),
iNumCond(0),
dMaxCond(0.),
dMinCond(std::numeric_limits<doublereal>::max()),
dSumCond(0.)
#ifdef USE_EXTERNAL
, ExtStepType(External::ERROR)  
#endif /* USE_EXTERNAL */
{
        std::memset(dTimeCPU, 0, sizeof(dTimeCPU));
}

NonlinearSolver::~NonlinearSolver ( void  )

virtual

Definition at line 461 of file nonlin.cc.

References pResTest, pSolTest, and SAFEDELETE.

{
        SAFEDELETE(pResTest);
        SAFEDELETE(pSolTest);
}

Member Function Documentation

void NonlinearSolver::AddCond ( doublereal  dCond )

inlineprotected

Definition at line 331 of file nonlin.h.

References dMaxCond, dMinCond, dSumCond, and iNumCond.

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

{
        iNumCond++;
        dSumCond += dCond;

        if (dCond > dMaxCond) {
                dMaxCond = dCond;
        }

        if (dCond < dMinCond) {
                dMinCond = dCond;
        }
}

void NonlinearSolver::AddTimeCPU ( doublereal  dTime, CPUTimeType  eType  )

inlineprotected

Definition at line 355 of file nonlin.h.

References ASSERT, CPU_LAST_TYPE, and dTimeCPU.

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

{
        ASSERT(eType >= 0);
        ASSERT(eType < CPU_LAST_TYPE);

        dTimeCPU[eType] += dTime;
}

doublereal NonlinearSolver::dGetCondAvg ( ) const

inlineprotected

Definition at line 277 of file nonlin.h.

References dSumCond, and iNumCond.

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

{ return dSumCond / iNumCond; }

doublereal NonlinearSolver::dGetCondMax ( ) const

inlineprotected

Definition at line 275 of file nonlin.h.

References dMaxCond.

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

{ return dMaxCond; }

doublereal NonlinearSolver::dGetCondMin ( ) const

inlineprotected

Definition at line 276 of file nonlin.h.

References dMinCond.

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

{ return dMinCond; }

doublereal NonlinearSolver::dGetTimeCPU ( CPUTimeType  eType ) const

inlineprotected

Definition at line 346 of file nonlin.h.

References ASSERT, CPU_LAST_TYPE, and dTimeCPU.

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

{
        ASSERT(eType >= 0);
        ASSERT(eType < CPU_LAST_TYPE);

        return dTimeCPU[eType];
}

bool NonlinearSolver::MakeResTest ( Solver *  pS, const NonlinearProblem *  pNLP, const VectorHandler &  Vec, const doublereal &  dTol, doublereal &  dTest, doublereal &  dTestDiff  )

virtual

Definition at line 474 of file nonlin.cc.

References NonlinearSolverOptions::dScaleAlgebraic, NonlinearSolverOptions::eScaleFlags, DataManager::IsConverged(), NonlinearSolverTest::MakeTest(), Solver::pGetDataManager(), pResTest, NonlinearSolverOptions::SCALE_ALGEBRAIC_EQUATIONS_NO, Size, and NonlinearProblem::TestScale().

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

{
        doublereal dScaleAlgEqu;
        const doublereal dTestScale = pNLP->TestScale(pResTest, dScaleAlgEqu);

        if (eScaleFlags == SCALE_ALGEBRAIC_EQUATIONS_NO) {
                // f = c / dCoef
                dScaleAlgEqu = 1.;
        } else {
                // f = c * dScaleAlgebraic
                dScaleAlgEqu *= dScaleAlgebraic;
        }

        dTest = pResTest->MakeTest(pS, Size, Vec, true, dScaleAlgEqu, &dTestDiff) * dTestScale;
        return ((dTest < dTol) && pS->pGetDataManager()->IsConverged());
}

Here is the call graph for this function:

bool NonlinearSolver::MakeSolTest ( Solver *  pS, const VectorHandler &  Vec, const doublereal &  dTol, doublereal &  dTest  )

protectedvirtual

Definition at line 497 of file nonlin.cc.

References DataManager::IsConverged(), NonlinearSolverTest::MakeTest(), Solver::pGetDataManager(), pSolTest, and Size.

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

{
        dTest = pSolTest->MakeTest(pS, Size, Vec);
        return ((dTest < dTol) && pS->pGetDataManager()->IsConverged());
}

Here is the call graph for this function:

virtual NonlinearSolverTest* NonlinearSolver::pGetResTest ( void  )

inlinevirtual

Definition at line 315 of file nonlin.h.

References pResTest.

                                                        {
                return pResTest;
        }

virtual NonlinearSolverTest* NonlinearSolver::pGetSolTest ( void  )

inlinevirtual

Definition at line 319 of file nonlin.h.

References pSolTest.

                                                        {
                return pSolTest;
        }

void NonlinearSolver::SetTest ( NonlinearSolverTest *  pr, NonlinearSolverTest *  ps  )

virtual

Definition at line 455 of file nonlin.cc.

References pResTest, and pSolTest.

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

{
        pResTest = pr;
        pSolTest = ps;
}  

virtual void NonlinearSolver::Solve ( const NonlinearProblem *  pNLP, Solver *  pS, const integer  iMaxIter, const doublereal &  Tol, integer &  iIterCnt, doublereal &  dErr, const doublereal &  SolTol, doublereal &  dSolErr  )

pure virtual

Implemented in LineSearchSolver, Gmres, NewtonRaphsonSolver, and BiCGStab.

Referenced by ThirdOrderIntegrator::Advance(), DerivativeSolver::Advance(), Step1Integrator::Advance(), Step2Integrator::Advance(), and InverseDynamicsStepSolver::Advance().

integer NonlinearSolver::TotalAssembledJacobian ( void  )

virtual

Definition at line 468 of file nonlin.cc.

References TotJac.

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

{
        return TotJac;
}

Member Data Documentation

doublereal NonlinearSolver::dMaxCond

private

Definition at line 285 of file nonlin.h.

Referenced by AddCond(), and dGetCondMax().

doublereal NonlinearSolver::dMinCond

private

Definition at line 286 of file nonlin.h.

Referenced by AddCond(), and dGetCondMin().

doublereal NonlinearSolver::dSumCond

private

Definition at line 287 of file nonlin.h.

Referenced by AddCond(), and dGetCondAvg().

doublereal NonlinearSolver::dTimeCPU[CPU_LAST_TYPE]

private

Definition at line 288 of file nonlin.h.

Referenced by AddTimeCPU(), dGetTimeCPU(), and NonlinearSolver().

integer NonlinearSolver::iNumCond

private

Definition at line 284 of file nonlin.h.

Referenced by AddCond(), and dGetCondAvg().

NonlinearSolverTest* NonlinearSolver::pResTest

protected

Definition at line 257 of file nonlin.h.

Referenced by MakeResTest(), pGetResTest(), SetTest(), and ~NonlinearSolver().

NonlinearSolverTest* NonlinearSolver::pSolTest

protected

Definition at line 258 of file nonlin.h.

Referenced by MakeSolTest(), pGetSolTest(), SetTest(), and ~NonlinearSolver().

integer NonlinearSolver::Size

protected

Definition at line 251 of file nonlin.h.

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

integer NonlinearSolver::TotJac

protected

Definition at line 252 of file nonlin.h.

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

---

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

• nonlin.h
• nonlin.cc