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

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

typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef FEMLightObject	Self

typedef itk::LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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 noexcept

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const override

Protected Member Functions inherited from itk::fem::FEMLightObject
	FEMLightObject ()

	FEMLightObject (const FEMLightObject &o)

virtual	~FEMLightObject () override

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
AtomicInt< int >	m_ReferenceCount

Additional Inherited Members
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Member Typedef Documentation

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

Array class that holds special pointers to the load objects

Definition at line 51 of file itkFEMLoadBase.h.

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

Definition at line 48 of file itkFEMLoadBase.h.

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

Definition at line 47 of file itkFEMLoadBase.h.

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

Standard class typedefs.

Definition at line 45 of file itkFEMLoadBase.h.

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

Definition at line 46 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 78 of file itkFEMLoadBase.h.

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::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadGravConst, 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 69 of file itkFEMLoadBase.h.

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

overrideprotectedvirtual

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::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::LoadLandmark, itk::fem::LoadNoisyLandmark, itk::fem::LoadBCMFC, itk::fem::LoadElement, itk::fem::LoadGravConst, itk::fem::LoadNode, itk::fem::LoadEdge, itk::fem::LoadPoint, 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 87 of file itkFEMLoadBase.h.

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