Stores and evaluates Lagrange terms within optimal control problems. More...
#include <lagrange_term.hpp>
Public Member Functions | |
| returnValue | addLagrangeTerm (const Expression &arg) |
| returnValue | addLagrangeTerm (const Expression &arg, const int &stageNumber) |
| const Grid & | getGrid () const |
| returnValue | init (const Grid &grid_) |
| LagrangeTerm () | |
| LagrangeTerm (const LagrangeTerm &rhs) | |
| LagrangeTerm & | operator= (const LagrangeTerm &rhs) |
| virtual | ~LagrangeTerm () |
Protected Attributes | |
| Grid | grid |
| Expression ** | lagrangeFcn |
| int | nLagrangeTerms |
Detailed Description
Stores and evaluates Lagrange terms within optimal control problems.
The class LagrangeTerm is object that is introduced as a kind of
temporary storage containter of the objective to store lagrange
terms that are defined by the user. As the objective does later
reformulate the Lagrange term into an Mayer term, this class has
no algorithmic functionality - it is just a data class.
Definition at line 61 of file lagrange_term.hpp.
Constructor & Destructor Documentation
Default constructor.
Definition at line 43 of file lagrange_term.cpp.
| LagrangeTerm::LagrangeTerm | ( | const LagrangeTerm & | rhs | ) |
Copy constructor (deep copy).
Definition at line 57 of file lagrange_term.cpp.
| LagrangeTerm::~LagrangeTerm | ( | ) | [virtual] |
Destructor.
Definition at line 72 of file lagrange_term.cpp.
Member Function Documentation
| returnValue LagrangeTerm::addLagrangeTerm | ( | const Expression & | arg | ) | [inline] |
Adds an expression for the Lagrange term.
- Returns:
- SUCCESSFUL_RETURN
| returnValue LagrangeTerm::addLagrangeTerm | ( | const Expression & | arg, |
| const int & | stageNumber | ||
| ) | [inline] |
Adds an expression for the Lagrange term.
- Returns:
- SUCCESSFUL_RETURN
| const Grid& LagrangeTerm::getGrid | ( | ) | const [inline] |
returns the objective grid
| returnValue LagrangeTerm::init | ( | const Grid & | grid_ | ) |
Sets the discretization grid.
- Returns:
- SUCCESSFUL_RETURN
Reimplemented in Objective.
Definition at line 50 of file lagrange_term.cpp.
| LagrangeTerm & LagrangeTerm::operator= | ( | const LagrangeTerm & | rhs | ) |
Assignment operator (deep copy).
Definition at line 84 of file lagrange_term.cpp.
Member Data Documentation
Grid LagrangeTerm::grid [protected] |
the objective grid.
Definition at line 112 of file lagrange_term.hpp.
Expression** LagrangeTerm::lagrangeFcn [protected] |
the Lagrange function.
Definition at line 114 of file lagrange_term.hpp.
int LagrangeTerm::nLagrangeTerms [protected] |
number of lagrange terms
Definition at line 113 of file lagrange_term.hpp.
The documentation for this class was generated from the following files: