Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OSCAR::PCGeneralizedInertialEfficiency Class Reference
[PerformanceCriteria]

PCGeneralizedInertialEfficiency is a criteria based upon the largest inertial eigenvalue. PCGeneralizedInertialEfficiency is derived from PCInertiaEigenValues. More...

#include <PCGeneralizedInertialEfficiency.h>

Inheritance diagram for OSCAR::PCGeneralizedInertialEfficiency:

Inheritance graph
[legend]
List of all members.

Public Methods

 PCGeneralizedInertialEfficiency (IDStandAlone *idObject, MinOrMax minOrMax=Minimize, double criticalLimit=-1, double weight=1.0, double exponent=1.0, const String &criteriaName=String("EFF"))
 PCGeneralizedInertialEfficiency (const PCGeneralizedInertialEfficiency &crit)
PCGeneralizedInertialEfficiency & operator= (const PCGeneralizedInertialEfficiency &crit)
virtual ~PCGeneralizedInertialEfficiency ()

Protected Methods

virtual bool computeCriteria (RepositoryList &repoList)

Detailed Description

Author:
Mark Tisius and Chetan Kapoor

Constructor & Destructor Documentation

OSCAR::PCGeneralizedInertialEfficiency::PCGeneralizedInertialEfficiency (  IDStandAlone *    idObject,
MinOrMax    minOrMax = Minimize,
double    criticalLimit = -1,
double    weight = 1.0,
double    exponent = 1.0,
const String &    criteriaName = String("EFF")
) 
 

Constructor for PCGeneralizedInertialEfficiency This constructor creates a PCGeneralizedInertialEfficiency object.

Parameters:
idObject A pointer to a IDStandAlone object which calculates the inertia matrices.
minOrMax Sets whether the criteria should be minimized or maximized. The default for vector limits criteria is MINIMIZE
criticalLimit The criticalLimit for the criteria which will be used to check validity and to normalize.
weight The weight of the criteria. The default is 1.0.
exponent The exponent of the criteria. The default is 1.0.
criteriaName The name of the criteria. The default is "EFF".

OSCAR::PCGeneralizedInertialEfficiency::PCGeneralizedInertialEfficiency (  const PCGeneralizedInertialEfficiency &    crit ) 
 

Copy Constructor for PCGeneralizedInertialEfficiency Use this to create a PCGeneralizedInertialEfficiency object whose defaults are set via the constructor argument. Note: The idLagrange, fkVelocity, and eigenvalues repository pointers are copied so changes to them will be seen by both criteria. A different repository will not be used to store the eigenvalues unless a different RepositoryList is sent to update().

Parameters:
crit A PCGeneralizedInertialEfficiency object that is used to create the new object

virtual OSCAR::PCGeneralizedInertialEfficiency::~PCGeneralizedInertialEfficiency (    )  [virtual]
 

Destructor for PCGeneralizedInertialEfficiency();.

Member Function Documentation

virtual bool OSCAR::PCGeneralizedInertialEfficiency::computeCriteria (  RepositoryList &    repoList )  [protected, virtual]
 

Implements OSCAR::PerformanceCriteria.

PCGeneralizedInertialEfficiency& OSCAR::PCGeneralizedInertialEfficiency::operator= (  const PCGeneralizedInertialEfficiency &    crit ) 
 

Copy operator for PCGeneralizedInertialEfficiency Use this to copy one PCGeneralizedInertialEfficiency object into another. Note: The idLagrange, fkVelocity, and eigenvalues repository pointers are copied so changes to them will be seen by both criteria. A different repository will not be used to store the eigenvalues unless a different RepositoryList is sent to update().

Returns:
A reference to itself
Parameters:
crit A PCGeneralizedInertialEfficiency object that is copied into the calling object.

The documentation for this class was generated from the following file:
RRG Homepage OSCAR Overview OSCAR Tutorials Simulations