PIControllerBasic Class Reference

#include <PIController.h>

Inheritance diagram for PIControllerBasic:

Public Member Functions
	PIControllerBasic ()=default
	PIControllerBasic (Mdouble pGain, Mdouble iGain)
void	set (Mdouble pGain, Mdouble iGain)
void	reset ()
Mdouble	apply (Mdouble error, Mdouble timeStep)
double	getIError () const

Private Attributes
Mdouble	pGain_ = 0.0
Mdouble	iGain_ = 0.0
Mdouble	iError_ = 0.0

Constructor & Destructor Documentation

PIControllerBasic() [1/2]

PIControllerBasic::PIControllerBasic ( )

default

PIControllerBasic() [2/2]

PIControllerBasic::PIControllerBasic ( Mdouble  pGain, Mdouble  iGain  )

inline

: pGain_(pGain), iGain_(iGain) {}

Member Function Documentation

apply()

Mdouble PIControllerBasic::apply	(	Mdouble	error,
		Mdouble	timeStep
	)

Applies a PI-controller, strain = pGain * error + iGain * interror, with the integrated stress interror += error * timeStep

Parameters

error	= (stress-stressGoal)
timeStep

Returns

strain

                                                                  {
    // Proportional Controller
    Mdouble pController = pGain_ * error;
 
    //Integral Controller
    iError_ += iGain_ * timeStep * error;
 
    // Controller Command
    return pController + iError_;
}

References calibrate::error, iError_, iGain_, and pGain_.

Referenced by PIController::apply().

getIError()

double PIControllerBasic::getIError ( ) const

inline

{ return iError_; }

References iError_.

reset()

void PIControllerBasic::reset

(

)

                               {
    iError_ = 0;
}

References iError_.

Referenced by PIController::reset().

set()

void PIControllerBasic::set	(	Mdouble	pGain,
		Mdouble	iGain
	)

{
    this->pGain_ = pGain;
    this->iGain_ = iGain;
    //logger(INFO,"Set PI controller with pGain %, iGain %", pGain, iGain);
}

References iGain_, and pGain_.

Referenced by StressStrainControlBoundary::set().

Member Data Documentation

iError_

Mdouble PIControllerBasic::iError_ = 0.0

private

Referenced by apply(), getIError(), and reset().

iGain_

Mdouble PIControllerBasic::iGain_ = 0.0

private

Referenced by apply(), and set().

pGain_

Mdouble PIControllerBasic::pGain_ = 0.0

private

Referenced by apply(), and set().

---

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

• PIController.h
• PIController.cc