nlSolver Class Referenceabstract
#include <rt-wdf_nlSolvers.h>
Inheritance diagram for nlSolver:
Public Member Functions | |
| nlSolver () | |
| virtual | ~nlSolver () |
| int | getNumPorts () |
| virtual void | nlSolve (vec *inWaves, vec *outWaves)=0 |
Public Attributes | |
| std::vector< nlModel * > | nlModels |
| int | numNLPorts |
Constructor & Destructor Documentation
§ nlSolver()
| nlSolver::nlSolver | ( | ) |
Parent class for all non-linear solvers.
§ ~nlSolver()
|
virtual |
Deconstructor.
Member Function Documentation
§ getNumPorts()
| int nlSolver::getNumPorts | ( | ) |
Function which returns the number of ports on an NL model for memory house- keeping
- Returns
- the total number of non-linear ports which are present at the root.
§ nlSolve()
|
pure virtual |
Virtual function that processes a vector of incoming waves and returns a vector of outgoing waves according to the specified nonlinearities.
Must be implemented in an NL solver according to the desired behaviour.
- Parameters
-
*inWaves is a pointer to a vector of incoming waves *outWaves is a pointer to a vector of outgoing waves *myMatData is a pointer to the E,F,M,N (and S) matrices
Implemented in nlNewtonSolver.
Member Data Documentation
§ nlModels
| std::vector<nlModel*> nlSolver::nlModels |
Vector of enums that specify the types on non-linearities in the solver
§ numNLPorts
| int nlSolver::numNLPorts |
Total number of non-linear ports which are present at the root.
The documentation for this class was generated from the following files:
- Libs/rt-wdf/rt-wdf_nlSolvers.h
- Libs/rt-wdf/rt-wdf_nlSolvers.cpp
