PIController Class Reference

#include <PIController.h>

+ Inheritance diagram for PIController:

Public Member Functions

 PIController ()=default
 
 PIController (Mdouble pGain, Mdouble iGain)
 
void reset ()
 
Mdouble apply (Mdouble error, Mdouble timeStep)
 
double getErrorVariance () const
 
unsigned getNApplied () const
 
- Public Member Functions inherited from PIControllerBasic
 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 sumErrorSquared_ = 0.0
 
unsigned nApplied_ = 0
 

Constructor & Destructor Documentation

◆ PIController() [1/2]

PIController::PIController ( )
default

◆ PIController() [2/2]

PIController::PIController ( Mdouble  pGain,
Mdouble  iGain 
)
inline
58 : PIControllerBasic(pGain, iGain) {}
PIControllerBasic()=default

Member Function Documentation

◆ apply()

Mdouble PIController::apply ( Mdouble  error,
Mdouble  timeStep 
)
40  {
42  nApplied_++;
43  return PIControllerBasic::apply (error, timeStep);
44 }
Mdouble apply(Mdouble error, Mdouble timeStep)
Definition: PIController.cc:25
unsigned nApplied_
Definition: PIController.h:52
Mdouble sumErrorSquared_
Definition: PIController.h:51
int error
Definition: calibrate.py:297

References PIControllerBasic::apply(), calibrate::error, nApplied_, and sumErrorSquared_.

Referenced by StressStrainControlBoundary::computeStrainRate(), and ControllerUnitTest::RungeKutta().

◆ getErrorVariance()

double PIController::getErrorVariance ( ) const
52  {
54 }

References nApplied_, and sumErrorSquared_.

◆ getNApplied()

unsigned PIController::getNApplied ( ) const
56  {
57  return nApplied_;
58 }

References nApplied_.

◆ reset()

void PIController::reset ( )
46  {
47  sumErrorSquared_ = 0.0;
48  nApplied_ = 0;
50 }
void reset()
Definition: PIController.cc:36

References nApplied_, PIControllerBasic::reset(), and sumErrorSquared_.

Referenced by StressStrainControlBoundary::set().

Member Data Documentation

◆ nApplied_

unsigned PIController::nApplied_ = 0
private

◆ sumErrorSquared_

Mdouble PIController::sumErrorSquared_ = 0.0
private

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


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