Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::fem::Load Class Reference

General abstract load base class. More...

#include <itkFEMLoadBase.h>

Inheritance diagram for itk::fem::Load:

Inheritance graph
[legend]
Collaboration diagram for itk::fem::Load:

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Methods

virtual void SetSolution (Solution::ConstPointer ptr)
virtual Solution::ConstPointer GetSolution ()

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

typedef FEMPArray<Self> itk::fem::Load::ArrayType
 

Array class that holds special pointers to the load objects

Definition at line 45 of file itkFEMLoadBase.h.

typedef const Self* itk::fem::Load::ConstPointer
 

Const pointer or SmartPointer to an object.

Reimplemented from itk::fem::FEMLightObject.

Reimplemented in itk::fem::ImageMetricLoad< TReference, TTarget >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadTest< TClass >, and itk::fem::ImageMetricLoad< ImageType, ImageType >.

Definition at line 41 of file itkFEMLoadBase.h.

typedef Self* itk::fem::Load::Pointer
 

Pointer or SmartPointer to an object.

Reimplemented from itk::fem::FEMLightObject.

Reimplemented in itk::fem::ImageMetricLoad< TReference, TTarget >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadTest< TClass >, and itk::fem::ImageMetricLoad< ImageType, ImageType >.

Definition at line 41 of file itkFEMLoadBase.h.

typedef Load itk::fem::Load::Self
 

Standard Self typedef.

Reimplemented from itk::fem::FEMLightObject.

Reimplemented in itk::fem::ImageMetricLoad< TReference, TTarget >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadTest< TClass >, and itk::fem::ImageMetricLoad< ImageType, ImageType >.

Definition at line 41 of file itkFEMLoadBase.h.

typedef FEMLightObject itk::fem::Load::Superclass
 

Standard Superclass typedef.

Reimplemented from itk::fem::FEMLightObject.

Reimplemented in itk::fem::ImageMetricLoad< TReference, TTarget >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadTest< TClass >, and itk::fem::ImageMetricLoad< ImageType, ImageType >.

Definition at line 41 of file itkFEMLoadBase.h.


Member Function Documentation

virtual Solution::ConstPointer itk::fem::Load::GetSolution   [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.

Parameters:
ptr  Pointer to the object of Solution class.

Reimplemented in itk::fem::ImageMetricLoad< TReference, TTarget >, itk::fem::LoadLandmark, and itk::fem::ImageMetricLoad< ImageType, ImageType >.

Definition at line 60 of file itkFEMLoadBase.h.

virtual void itk::fem::Load::SetSolution Solution::ConstPointer    ptr [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.

Parameters:
ptr  Pointer to the object of Solution class.

Reimplemented in itk::fem::ImageMetricLoad< TReference, TTarget >, itk::fem::LoadLandmark, and itk::fem::ImageMetricLoad< ImageType, ImageType >.

Definition at line 59 of file itkFEMLoadBase.h.


The documentation for this class was generated from the following file:
Generated at Wed Mar 12 01:22:21 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000