ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
itk::fem::Load Class Reference

General abstract load base class. More...

#include <itkFEMLoadBase.h>

Inheritance diagram for itk::fem::Load:
Collaboration diagram for itk::fem::Load:

List of all members.

Public Types

typedef FEMPArray< SelfArrayType
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef Load Self
typedef FEMLightObject Superclass

Public Member Functions

Element::ConstPointer GetElement () const
virtual const char * GetNameOfClass () const
virtual Solution::ConstPointer GetSolution ()
virtual void SetSolution (Solution::ConstPointer)
void SetElement (Element::ConstPointer el)
void SetElement (Element::Pointer el)

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const

Protected Attributes

Element::ConstPointer m_Element

Detailed Description

General abstract load base class.

All other load classes that can be used in a FEM system are defined by deriving this one. The load class defines an external load that acts on the system. For each specific subtype of load, a separate load abstract class should be derived. For example we have LoadElement, which defines the base for all loads that act on a specific element in a system.

Definition at line 39 of file itkFEMLoadBase.h.


Member Typedef Documentation

Array class that holds special pointers to the load objects

Definition at line 50 of file itkFEMLoadBase.h.


Member Function Documentation

Element::ConstPointer itk::fem::Load::GetElement ( ) const [inline]

Get the element containing the degree of freedom on which the force is being applied.

Definition at line 77 of file itkFEMLoadBase.h.

References m_Element.

virtual const char* itk::fem::Load::GetNameOfClass ( ) const [virtual]
virtual Solution::ConstPointer itk::fem::Load::GetSolution ( ) [inline, virtual]
virtual void itk::fem::Load::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::fem::FEMLightObject.

Reimplemented in itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, and itk::fem::LoadPoint.

void itk::fem::Load::SetElement ( Element::ConstPointer  el) [inline]

Get the element containing the degree of freedom on which the force is being applied.

Definition at line 86 of file itkFEMLoadBase.h.

References m_Element.

void itk::fem::Load::SetElement ( Element::Pointer  el) [inline]

Get the element containing the degree of freedom on which the force is being applied.

Definition at line 90 of file itkFEMLoadBase.h.

References itk::SmartPointer< TObjectType >::GetPointer(), and m_Element.

virtual void itk::fem::Load::SetSolution ( Solution::ConstPointer  ) [inline, virtual]

Sets the pointer to solution vector. This function is automatically called by the Solver class on every load object.

Some types of external Loads may need access to previous values of solution vector. If a derived class needs that, it should implement this function, and store the passed pointer accordingly. If the result vector is not required, the functionn should be left unimplemented, so that only the dummy implementation in base class is called.

param ptr Pointer to the object of Solution class.

Reimplemented in itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadLandmark, and itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >.

Definition at line 67 of file itkFEMLoadBase.h.


Member Data Documentation


The documentation for this class was generated from the following file: