#include <itkFEMLoadBase.h>

Inheritance diagram for itk::fem::Load:

Collaboration diagram for itk::fem::Load:

Public Types
typedef FEMPArray< Self >	ArrayType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Load	Self
typedef FEMLightObject	Superclass
Public Types inherited from itk::fem::FEMLightObject
typedef Self	Baseclass
Public Types inherited from itk::LightObject

Public Member Functions
const Element *	GetElement () const
virtual const char *	GetNameOfClass () const
virtual Solution::ConstPointer	GetSolution ()
void	SetElement (const Element *el)
virtual void	SetSolution (Solution::ConstPointer)
Public Member Functions inherited from itk::fem::FEMLightObject
int	GetGlobalNumber () const
void	SetGlobalNumber (int)
Public Member Functions inherited from itk::LightObject
virtual Pointer	CreateAnother () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const
Protected Member Functions inherited from itk::fem::FEMLightObject
	FEMLightObject ()
	FEMLightObject (const FEMLightObject &o)
virtual	~FEMLightObject ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
Element::ConstPointer	m_Element
Protected Attributes inherited from itk::fem::FEMLightObject
int	m_GlobalNumber
Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

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 50 of file itkFEMLoadBase.h.

typedef SmartPointer<const Self> itk::fem::Load::ConstPointer

Reimplemented from itk::fem::FEMLightObject.

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

Definition at line 47 of file itkFEMLoadBase.h.

typedef SmartPointer<Self> itk::fem::Load::Pointer

Reimplemented from itk::fem::FEMLightObject.

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

Definition at line 46 of file itkFEMLoadBase.h.

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

Standard class typedefs.

Reimplemented from itk::fem::FEMLightObject.

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

Definition at line 44 of file itkFEMLoadBase.h.

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

Reimplemented from itk::fem::FEMLightObject.

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

Definition at line 45 of file itkFEMLoadBase.h.

Member Function Documentation

const Element* 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

Run-time type information (and related methods).

Reimplemented from itk::fem::FEMLightObject.

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

virtual Solution::ConstPointer itk::fem::Load::GetSolution ( )

inlinevirtual

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

Definition at line 68 of file itkFEMLoadBase.h.

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

protectedvirtual

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::LoadLandmark, itk::fem::LoadNoisyLandmark, itk::fem::LoadBCMFC, itk::fem::LoadGravConst, itk::fem::LoadElement, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadEdge, itk::fem::LoadBC, and itk::fem::LoadGrav.

void itk::fem::Load::SetElement ( const Element * 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.

virtual void itk::fem::Load::SetSolution ( Solution::ConstPointer )

inlinevirtual

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::FiniteDifferenceFunctionLoad< TMoving, TFixed >, and itk::fem::LoadLandmark.

Definition at line 67 of file itkFEMLoadBase.h.