itk::fem::Solution Class Reference
Provides functions to access the values of the solution vector. More...
#include <itkFEMSolution.h>
Public Types | |
| typedef const Self * | ConstPointer |
| typedef double | Float |
| typedef Self * | Pointer |
| typedef Solution | Self |
| typedef Solution | Superclass |
Public Member Functions | |
| virtual Float | GetSolutionValue (unsigned int i, unsigned int solutionIndex=0) const =0 |
| virtual | ~Solution () |
Detailed Description
Provides functions to access the values of the solution vector.The actual code of these functions as well as storage for the data is implemented in LinearSystemWrapper class.
- See also:
- LinearSystemWrapper
Definition at line 33 of file itkFEMSolution.h.
Member Typedef Documentation
| typedef const Self* itk::fem::Solution::ConstPointer |
Const pointer to an object.
Reimplemented in itk::fem::LinearSystemWrapper.
Definition at line 47 of file itkFEMSolution.h.
| typedef double itk::fem::Solution::Float |
Floating point storage type used within a class
Reimplemented in itk::fem::LinearSystemWrapperDenseVNL, and itk::fem::LinearSystemWrapperVNL.
Definition at line 50 of file itkFEMSolution.h.
| typedef Self* itk::fem::Solution::Pointer |
Pointer to an object.
Reimplemented in itk::fem::LinearSystemWrapper.
Definition at line 44 of file itkFEMSolution.h.
| typedef Solution itk::fem::Solution::Self |
Standard "Self" typedef.
Reimplemented in itk::fem::LinearSystemWrapper, and itk::fem::LinearSystemWrapperItpack.
Definition at line 38 of file itkFEMSolution.h.
Standard "Superclass" typedef.
Reimplemented in itk::fem::LinearSystemWrapper, and itk::fem::LinearSystemWrapperItpack.
Definition at line 41 of file itkFEMSolution.h.
Constructor & Destructor Documentation
| virtual itk::fem::Solution::~Solution | ( | ) | [inline, virtual] |
Virtual destructor should properly destroy the object and clean up any memory allocated for matrix and vector storage.
Definition at line 71 of file itkFEMSolution.h.
Member Function Documentation
| virtual Float itk::fem::Solution::GetSolutionValue | ( | unsigned int | i, | |
| unsigned int | solutionIndex = 0 | |||
| ) | const [pure virtual] |
Returns value of i-th element in a solution vector. This value is calculated generalized displacement of the i-th degree of freedom in a FEM problem. Note that in general there may be several solution vectors. You can select which one do you want by passing the second parameter.
- Parameters:
-
i element index in solution vector solutionIndex index of solution vector to get value from
- Note:
- If the solution vector doesn't exist (problem was not yet solved), or the index i is out of range, the function returns 0.0.
Implemented in itk::fem::LinearSystemWrapperDenseVNL, itk::fem::LinearSystemWrapperItpack, and itk::fem::LinearSystemWrapperVNL.
Referenced by itk::fem::Solver::GetSolution(), itk::fem::LoadLandmark::GetSolution(), itk::fem::ImageMetricLoad< TMoving, TFixed >::GetSolution(), and itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetSolution().
The documentation for this class was generated from the following file:
