Factor Class Reference

#include <TimeStepControl.h>

Inheritance diagram for Factor:

Collaboration diagram for Factor:

Public Member Functions
	Factor (Solver *s, doublereal dReductionFactor, doublereal iStepsBeforeReduction, doublereal dRaiseFactor, doublereal iStepsBeforeRaise, doublereal iMinIters, doublereal iMaxIters)
	~Factor (void)
doublereal	dGetNewStepTime (StepIntegrator::StepChange Why, doublereal iPerformedIters)
void	SetDriveHandler (const DriveHandler *driveHandler)
void	Init (integer iMaxIterations, doublereal dMinTimeStep, const DriveOwner &MaxTimeStep, doublereal dInitialTimeStep)
Public Member Functions inherited from TimeStepControl
	TimeStepControl (void)
virtual	~TimeStepControl (void)

Private Attributes
Solver *	s
doublereal	dReductionFactor
doublereal	iStepsBeforeReduction
doublereal	dRaiseFactor
doublereal	iStepsBeforeRaise
doublereal	iMinIters
doublereal	iMaxIters
bool	bLastChance
doublereal	iStepsAfterReduction
doublereal	iStepsAfterRaise
doublereal	iWeightedPerformedIters
doublereal	dMinTimeStep
DriveOwner	MaxTimeStep

Additional Inherited Members
Protected Attributes inherited from TimeStepControl
doublereal	dCurrTimeStep

Detailed Description

Definition at line 102 of file TimeStepControl.h.

Constructor & Destructor Documentation

Factor::Factor	(	Solver *	s,
		doublereal	dReductionFactor,
		doublereal	iStepsBeforeReduction,
		doublereal	dRaiseFactor,
		doublereal	iStepsBeforeRaise,
		doublereal	iMinIters,
		doublereal	iMaxIters
	)

Definition at line 176 of file TimeStepControl.cc.

References NO_OP.

: s(s),
dReductionFactor(dReductionFactor),
iStepsBeforeReduction(iStepsBeforeReduction),
dRaiseFactor(dRaiseFactor),
iStepsBeforeRaise(iStepsBeforeRaise),
iMinIters(iMinIters),
iMaxIters(iMaxIters),
bLastChance(false),
iStepsAfterReduction(0),
iStepsAfterRaise(0),
iWeightedPerformedIters(0),
dMinTimeStep(::dDefaultMinTimeStep)
{
        NO_OP;
}

Factor::~Factor ( void  )

inline

Definition at line 126 of file TimeStepControl.h.

References NO_OP.

{ NO_OP; };

Member Function Documentation

doublereal Factor::dGetNewStepTime ( StepIntegrator::StepChange  Why, doublereal  iPerformedIters  )

virtual

Implements TimeStepControl.

Definition at line 200 of file TimeStepControl.cc.

References ASSERT, bLastChance, TimeStepControl::dCurrTimeStep, DriveOwner::dGet(), dMinTimeStep, dRaiseFactor, dReductionFactor, iMaxIters, iMinIters, iStepsAfterRaise, iStepsAfterReduction, iStepsBeforeRaise, iStepsBeforeReduction, iWeightedPerformedIters, MaxTimeStep, MBDYN_EXCEPT_ARGS, StepIntegrator::NEWSTEP, and StepIntegrator::REPEATSTEP.

{
        doublereal dMaxTimeStep = MaxTimeStep.dGet();
        
        switch (Why) {
        case StepIntegrator::REPEATSTEP:
                if (dCurrTimeStep*dReductionFactor > dMinTimeStep) {
                        if (bLastChance) {
                                bLastChance = false;
                        }
                        iStepsAfterReduction = 0;
                        return (dCurrTimeStep = std::min(dCurrTimeStep*dReductionFactor, dMaxTimeStep));
                }

                if (!bLastChance) {
                        bLastChance = true;
                        return (dCurrTimeStep = dMinTimeStep);
                }

                return (dCurrTimeStep = std::min(dCurrTimeStep*dReductionFactor, dMaxTimeStep));

        case StepIntegrator::NEWSTEP:
                iStepsAfterReduction++;
                iStepsAfterRaise++;

                iWeightedPerformedIters = (10*iPerformedIters + 9*iWeightedPerformedIters)/10;

                if (iPerformedIters > iMaxIters) {
                        iStepsAfterReduction = 0;
                        bLastChance = false;
                        return (dCurrTimeStep = std::min(std::max(dCurrTimeStep*dReductionFactor, dMinTimeStep), dMaxTimeStep));

                }

                if (iPerformedIters <= iMinIters
                                && iStepsAfterReduction >iStepsBeforeReduction
                                && iStepsAfterRaise > iStepsBeforeRaise
                                && dCurrTimeStep < dMaxTimeStep)
                {
                        iStepsAfterRaise = 0;
                        iWeightedPerformedIters = 0;
                        return (dCurrTimeStep = std::min(dCurrTimeStep*dRaiseFactor, dMaxTimeStep));
                }

                return dCurrTimeStep;

        default:
                // Should Not Reach Over here
                ASSERT(0);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }
}

Here is the call graph for this function:

void Factor::Init ( integer  iMaxIterations, doublereal  dMinTimeStep, const DriveOwner &  MaxTimeStep, doublereal  dInitialTimeStep  )

virtual

Implements TimeStepControl.

Definition at line 255 of file TimeStepControl.cc.

References TimeStepControl::dCurrTimeStep, dDefaultMinTimeStep, DriveOwner::dGet(), dMinTimeStep, iMaxIters, iMinIters, MBDYN_EXCEPT_ARGS, DriveCaller::pCopy(), DriveOwner::pGetDriveCaller(), and DriveOwner::Set().

{
        this->dCurrTimeStep = dInitialTimeStep;
        this->MaxTimeStep.Set(MaxTimeStep.pGetDriveCaller()->pCopy());
        this->dMinTimeStep = dMinTimeStep;

        if (iMaxIters <= iMinIters) {
                silent_cerr("error: maximum number of iterations " << iMaxIters << " less than or equal to minimum " << iMinIters << std::endl);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        doublereal dInitialMaxTimeStep = MaxTimeStep.dGet();

        if (typeid(*MaxTimeStep.pGetDriveCaller()) == typeid(ConstDriveCaller)
                        && dInitialMaxTimeStep == std::numeric_limits<doublereal>::max())
        {
                silent_cerr("warning: maximum time step not set; the initial time step value " << dInitialTimeStep << " will be used" << std::endl);
        }

        if (dMinTimeStep == ::dDefaultMinTimeStep) {
                silent_cerr("warning: minimum time step not set; the initial time step value " << dInitialTimeStep << " will be used" << std::endl);
                dMinTimeStep = dInitialTimeStep;
        }

        if (dMinTimeStep == dInitialMaxTimeStep) {
                silent_cerr("warning: minimum time step " << dMinTimeStep << "is equal to (initial) maximum time step " << dInitialMaxTimeStep << "; no time step adaptation will take place" << std::endl);

        } else if (dMinTimeStep == dInitialMaxTimeStep) {
                silent_cerr("error: minimum time step " << dMinTimeStep << "is greater than (initial) maximum time step " << dInitialMaxTimeStep << std::endl);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }
}

Here is the call graph for this function:

void Factor::SetDriveHandler ( const DriveHandler *  driveHandler )

inlinevirtual

Implements TimeStepControl.

Definition at line 128 of file TimeStepControl.h.

References NO_OP.

{ NO_OP; };

Member Data Documentation

bool Factor::bLastChance

private

Definition at line 111 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

doublereal Factor::dMinTimeStep

private

Definition at line 115 of file TimeStepControl.h.

Referenced by dGetNewStepTime(), and Init().

doublereal Factor::dRaiseFactor

private

Definition at line 107 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

doublereal Factor::dReductionFactor

private

Definition at line 105 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

doublereal Factor::iMaxIters

private

Definition at line 110 of file TimeStepControl.h.

Referenced by dGetNewStepTime(), and Init().

doublereal Factor::iMinIters

private

Definition at line 109 of file TimeStepControl.h.

Referenced by dGetNewStepTime(), and Init().

doublereal Factor::iStepsAfterRaise

private

Definition at line 113 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

doublereal Factor::iStepsAfterReduction

private

Definition at line 112 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

doublereal Factor::iStepsBeforeRaise

private

Definition at line 108 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

doublereal Factor::iStepsBeforeReduction

private

Definition at line 106 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

doublereal Factor::iWeightedPerformedIters

private

Definition at line 114 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

DriveOwner Factor::MaxTimeStep

private

Definition at line 116 of file TimeStepControl.h.

Referenced by dGetNewStepTime().

Solver* Factor::s

private

Definition at line 104 of file TimeStepControl.h.

---

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

• TimeStepControl.h
• TimeStepControl.cc