![]() |
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkFEMSolver.h>
FEM solver used to generate a solution for a FE formulation.
This class will solve the FE formulation provided in an FEMObject. The FEMObject contains the Elements, Material properties, Loads, and boundary conditions for the FE problem. The user can define properties of the solver including the time step using the SetTimeStep() method and the numerical solver via the SetLinearSystemWrapper() method. The output of the filter is the deformed FEMObject that also includes all of the loads and boundary conditions.
The solution generated by the Solver can also be acquired using the GetSolution() method. The FEM can be saved in a file using the spatial objects and the Meta I/O library.
Definition at line 73 of file itkFEMSolver.h.
Static Public Member Functions | |
static Pointer | New () |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
typedef SmartPointer<const Self> itk::fem::Solver< VDimension >::ConstPointer |
Definition at line 80 of file itkFEMSolver.h.
typedef DataObject::Pointer itk::fem::Solver< VDimension >::DataObjectPointer |
Definition at line 95 of file itkFEMSolver.h.
typedef ProcessObject::DataObjectPointerArraySizeType itk::fem::Solver< VDimension >::DataObjectPointerArraySizeType |
Make a DataObject of the correct type to be used as the specified output.
Definition at line 258 of file itkFEMSolver.h.
typedef Element::ArrayType itk::fem::Solver< VDimension >::ElementArray |
Definition at line 101 of file itkFEMSolver.h.
typedef FEMObjectType::ConstPointer itk::fem::Solver< VDimension >::FEMObjectConstPointer |
Definition at line 94 of file itkFEMSolver.h.
typedef FEMObjectType::Pointer itk::fem::Solver< VDimension >::FEMObjectPointer |
Definition at line 93 of file itkFEMSolver.h.
typedef itk::fem::FEMObject<VDimension> itk::fem::Solver< VDimension >::FEMObjectType |
Smart Pointer type to a DataObject.
Definition at line 92 of file itkFEMSolver.h.
typedef Element::Float itk::fem::Solver< VDimension >::Float |
Some convenient typedefs.
Definition at line 98 of file itkFEMSolver.h.
typedef InterpolationGridType::DirectionType itk::fem::Solver< VDimension >::InterpolationGridDirectionType |
Definition at line 115 of file itkFEMSolver.h.
typedef InterpolationGridType::IndexType itk::fem::Solver< VDimension >::InterpolationGridIndexType |
Definition at line 114 of file itkFEMSolver.h.
typedef InterpolationGridType::Pointer itk::fem::Solver< VDimension >::InterpolationGridPointerType |
Definition at line 109 of file itkFEMSolver.h.
typedef InterpolationGridType::PointType itk::fem::Solver< VDimension >::InterpolationGridPointType |
Definition at line 112 of file itkFEMSolver.h.
typedef InterpolationGridType::RegionType itk::fem::Solver< VDimension >::InterpolationGridRegionType |
Definition at line 111 of file itkFEMSolver.h.
typedef InterpolationGridType::SizeType itk::fem::Solver< VDimension >::InterpolationGridSizeType |
Definition at line 110 of file itkFEMSolver.h.
typedef InterpolationGridType::SpacingType itk::fem::Solver< VDimension >::InterpolationGridSpacingType |
Definition at line 113 of file itkFEMSolver.h.
typedef itk::Image<Element::ConstPointer, VDimension> itk::fem::Solver< VDimension >::InterpolationGridType |
Type used to store interpolation grid
Definition at line 108 of file itkFEMSolver.h.
typedef Load::ArrayType itk::fem::Solver< VDimension >::LoadArray |
Definition at line 102 of file itkFEMSolver.h.
typedef Material::ArrayType itk::fem::Solver< VDimension >::MaterialArray |
Definition at line 103 of file itkFEMSolver.h.
typedef Element::Node::ArrayType itk::fem::Solver< VDimension >::NodeArray |
Definition at line 100 of file itkFEMSolver.h.
typedef SmartPointer<Self> itk::fem::Solver< VDimension >::Pointer |
Definition at line 79 of file itkFEMSolver.h.
typedef Solver itk::fem::Solver< VDimension >::Self |
Standard class typedefs.
Definition at line 77 of file itkFEMSolver.h.
typedef ProcessObject itk::fem::Solver< VDimension >::Superclass |
Definition at line 78 of file itkFEMSolver.h.
typedef Element::VectorType itk::fem::Solver< VDimension >::VectorType |
Definition at line 99 of file itkFEMSolver.h.
|
protected |
Make a DataObject of the correct type to be used as the specified output.
|
overrideprotectedvirtual |
Make a DataObject of the correct type to be used as the specified output.
|
protected |
Apply the boundary conditions to the system.
matrix | Index of a matrix, to which the BCs should be applied (master stiffness matrix). Normally this is zero, but in derived classes many matrices may be used and this index must be specified. |
dim | This is a parameter that can be passed to the function and is normally used with isotropic elements to specify the dimension in which the DOF is fixed. |
|
protectedvirtual |
Copy the element stiffness matrix into the correct position in the master stiffess matrix. Since more complex Solver classes may need to assemble many matrices and may also do some funky stuff to them, this function is virtual and can be overriden in a derived solver class.
Reimplemented in itk::fem::SolverHyperbolic< TDimension >.
|
protected |
Assemble the master force vector.
dim | This is a parameter that can be passed to the function and is normally used with isotropic elements to specify the dimension for which the master force vector should be assembled. |
|
protected |
System solver functions. Call all six functions below (in listed order) to solve system. Assign a global freedom numbers to each DOF in a system. This must be done before any other solve function can be called.Assemble the master stiffness matrix (also apply the MFCs to K).
|
protectedvirtual |
Add the contribution of the landmark-containing elements to the correct position in the master stiffess matrix. Since more complex Solver classes may need to assemble many matrices and may also do some funky stuff to them, this function is virtual and can be overriden in a derived solver class.
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
|
protected |
Decompose matrix using svd, qr, etc. if needed.
|
protected |
Fill the interpolation grid based on the current deformed grid.
|
inlineprotectedvirtual |
This function is called after the assebly has been completed. In this class it is only used to apply the BCs. You may however use it to perform other stuff in derived solver classes.
Reimplemented in itk::fem::SolverHyperbolic< TDimension >.
Definition at line 315 of file itkFEMSolver.h.
|
overrideprotectedvirtual |
Method invoked by the pipeline in order to trigger the computation of the registration.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::fem::SolverCrankNicolson< TDimension >, itk::fem::RobustSolver< VDimension >, and itk::fem::SolverHyperbolic< TDimension >.
Float itk::fem::Solver< VDimension >::GetDeformationEnergy | ( | unsigned int | SolutionIndex = 0 | ) |
Get the total deformation energy using the chosen solution
|
virtual |
Get/Set the interpolation grid direction.
const Element* itk::fem::Solver< VDimension >::GetElementAtPoint | ( | const VectorType & | pt | ) | const |
Returns the pointer to the element which contains global point pt.
pt | Point in global coordinate system. |
FEMObjectType* itk::fem::Solver< VDimension >::GetInput | ( | ) |
FEMObjectType* itk::fem::Solver< VDimension >::GetInput | ( | unsigned int | idx | ) |
|
inline |
Returns pointer to interpolation grid, which is an itk::Image of pointers to Element objects. Normally you would use physical coordinates to get specific points (pointers to elements) from the image. You can then use the Elemenet::InterpolateSolution member function on the returned element to obtain the solution at this point.
Definition at line 250 of file itkFEMSolver.h.
|
inline |
Gets the LinearSystemWrapper object.
Definition at line 195 of file itkFEMSolver.h.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ProcessObject.
Reimplemented in itk::fem::RobustSolver< VDimension >, and itk::fem::SolverHyperbolic< TDimension >.
|
virtual |
Get/Set the interpolation grid Origin.
FEMObjectType* itk::fem::Solver< VDimension >::GetOutput | ( | ) |
Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data.
For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.
FEMObjectType* itk::fem::Solver< VDimension >::GetOutput | ( | unsigned int | idx | ) |
Make a DataObject of the correct type to be used as the specified output.
|
virtual |
Get/Set the interpolation grid region.
Float itk::fem::Solver< VDimension >::GetSolution | ( | unsigned int | i, |
unsigned int | which = 0 |
||
) |
Returns the Solution for the specified nodal point.
|
virtual |
Get/Set the interpolation grid spacing.
|
virtual |
Returns the time step used for dynamic problems.
Reimplemented in itk::fem::SolverCrankNicolson< TDimension >, and itk::fem::SolverHyperbolic< TDimension >.
void itk::fem::Solver< VDimension >::InitializeInterpolationGrid | ( | const InterpolationGridSizeType & | size, |
const InterpolationGridPointType & | bb1, | ||
const InterpolationGridPointType & | bb2 | ||
) |
Initialize the interpolation grid. The interpolation grid is used to find elements that containg specific points in a mesh. The interpolation grid stores pointers to elements for each point on a grid thereby providing a fast way (lookup table) to perform interpolation of results.
size | Vector that represents number of points on a grid in each dimension. |
bb1 | Lower limit of a bounding box of a grid. |
bb2 | Upper limit of a bounding box of a grid. |
|
inline |
Same as InitializeInterpolationGrid(size, {0,0...}, size);
Definition at line 218 of file itkFEMSolver.h.
void itk::fem::Solver< VDimension >::InitializeInterpolationGrid | ( | const InterpolationGridRegionType & | region, |
const InterpolationGridPointType & | origin, | ||
const InterpolationGridSpacingType & | spacing, | ||
const InterpolationGridDirectionType & | direction | ||
) |
Initialize the interpolation grid, over the domain specified by the user.
|
protectedvirtual |
Performs any initialization needed for LinearSystemWrapper object i.e. sets the maximum number of matrices and vectors.
Reimplemented in itk::fem::SolverHyperbolic< TDimension >.
|
protectedvirtual |
This function is called before assembling the matrices. You can override it in a derived class to account for special needs.
N | Size of the matrix. |
Reimplemented in itk::fem::SolverHyperbolic< TDimension >.
|
overridevirtual |
Make a DataObject of the correct type to be used as the specified output.
Reimplemented from itk::ProcessObject.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Make a DataObject of the correct type to be used as the specified output.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::fem::SolverHyperbolic< TDimension >.
|
protectedvirtual |
Solve for the displacement vector u. May be overriden in derived classes.
Reimplemented in itk::fem::SolverCrankNicolson< TDimension >, itk::fem::RobustSolver< VDimension >, and itk::fem::SolverHyperbolic< TDimension >.
|
virtual |
Get/Set the interpolation grid direction.
|
virtual |
|
virtual |
void itk::fem::Solver< VDimension >::SetLinearSystemWrapper | ( | LinearSystemWrapper::Pointer | ls | ) |
Sets the LinearSystemWrapper object that will be used when solving the master equation. If this function is not called, a default VNL linear system representation will be used (class LinearSystemWrapperVNL).
ls | Pointer to an object of class which is derived from LinearSystemWrapper. |
|
virtual |
Get/Set the interpolation grid Origin.
|
virtual |
Get/Set the interpolation grid region.
|
virtual |
Get/Set the interpolation grid spacing.
|
virtual |
Sets the time step used for dynamic problems.
dt | New time step. |
Reimplemented in itk::fem::SolverCrankNicolson< TDimension >, and itk::fem::SolverHyperbolic< TDimension >.
|
protected |
Copy solution vector u to the corresponding nodal values, which are stored in node objects). This is standard post processing of the solution.
|
static |
Definition at line 88 of file itkFEMSolver.h.
|
private |
Make a DataObject of the correct type to be used as the specified output.
Definition at line 415 of file itkFEMSolver.h.
|
protected |
Make a DataObject of the correct type to be used as the specified output.
Definition at line 406 of file itkFEMSolver.h.
|
protected |
An Image of pointers to Element objects that represents a grid used for interpolation of solution. Each Pixel in an image is a pointer to an Element object in which that pixel is located.
Definition at line 404 of file itkFEMSolver.h.
|
protected |
Pointer to LinearSystemWrapper object.
Definition at line 394 of file itkFEMSolver.h.
|
protected |
LinearSystemWrapperVNL object that is used by default in Solver class.
Definition at line 397 of file itkFEMSolver.h.
|
protected |
Number of global degrees of freedom in a system.
Definition at line 385 of file itkFEMSolver.h.
|
protected |
Number of multi freedom constraints in a system. This member is set in a AssembleK function.
Definition at line 391 of file itkFEMSolver.h.
|
private |
Make a DataObject of the correct type to be used as the specified output.
Definition at line 413 of file itkFEMSolver.h.
|
private |
Properties of the interpolation grid.
Definition at line 409 of file itkFEMSolver.h.
|
private |
Make a DataObject of the correct type to be used as the specified output.
Definition at line 414 of file itkFEMSolver.h.
|
static |
Definition at line 89 of file itkFEMSolver.h.