itk::fem::LoadElement Class Reference

#include <itkFEMLoadElementBase.h>

Inheritance diagram for itk::fem::LoadElement:

Collaboration diagram for itk::fem::LoadElement:

Detailed Description

Virtual element load base class.

This load class defines an external load that acts on elements in a system. The vector with pointers to elements defines, on which elements the load acts. The derived load classes should provide members, that allow the Element's class Fe() member function to uniquely transform the load into nodal loads. No special requirements are enforced on those members.

Ultimately, when assembling the right hand side of the master equation (master force vector) the Element's Fe() member function is called with the pointer to the LoadElement class that is prescribed on that element. Fe() function shuld dynamically cast this pointer to specific load class, which it can handle and return the element's force vector.

Definition at line 45 of file itkFEMLoadElementBase.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef std::vector< const Element * >	ElementPointersVectorType
typedef Element::Float	Float
typedef SmartPointer< Self >	Pointer
typedef LoadElement	Self
typedef Load	Superclass
Public Types inherited from itk::fem::Load
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
void	AddNextElement (Element::ConstPointer e)
void	AddNextElement (Element::Pointer e)
virtual void	ApplyLoad (Element::ConstPointer, Element::VectorType &)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const override
Element::ConstPointer	GetElement (int i)
ElementPointersVectorType &	GetElementArray ()
const ElementPointersVectorType &	GetElementArray () const
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfElements ()
	LoadElement ()
Public Member Functions inherited from itk::fem::Load
const Element *	GetElement () 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 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

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
void	AddNextElementInternal (const Element *e)
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 ()

Additional Inherited Members
Protected Attributes inherited from itk::fem::Load
Element::ConstPointer	m_Element
Protected Attributes inherited from itk::fem::FEMLightObject
int	m_GlobalNumber
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

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

Definition at line 53 of file itkFEMLoadElementBase.h.

typedef std::vector<const Element *> itk::fem::LoadElement::ElementPointersVectorType

Type of array of pointers to element objects

Definition at line 73 of file itkFEMLoadElementBase.h.

typedef Element::Float itk::fem::LoadElement::Float

Float type used in Element and derived classes

Definition at line 68 of file itkFEMLoadElementBase.h.

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

Definition at line 52 of file itkFEMLoadElementBase.h.

typedef LoadElement itk::fem::LoadElement::Self

Standard class typedefs.

Definition at line 50 of file itkFEMLoadElementBase.h.

typedef Load itk::fem::LoadElement::Superclass

Definition at line 51 of file itkFEMLoadElementBase.h.

Constructor & Destructor Documentation

itk::fem::LoadElement::LoadElement ( )

inline

Definition at line 76 of file itkFEMLoadElementBase.h.

Member Function Documentation

void itk::fem::LoadElement::AddNextElement ( Element::ConstPointer  e )

inline

Definition at line 79 of file itkFEMLoadElementBase.h.

References itk::SmartPointer< TObjectType >::GetPointer().

void itk::fem::LoadElement::AddNextElement ( Element::Pointer  e )

inline

Definition at line 83 of file itkFEMLoadElementBase.h.

References itk::SmartPointer< TObjectType >::GetPointer().

void itk::fem::LoadElement::AddNextElementInternal ( const Element *  e )

protected

virtual void itk::fem::LoadElement::ApplyLoad ( Element::ConstPointer  , Element::VectorType &    )

inlinevirtual

Apply the load to the specified element

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

Definition at line 103 of file itkFEMLoadElementBase.h.

virtual::itk::LightObject::Pointer itk::fem::LoadElement::CreateAnother ( void  ) const

overridevirtual

CreateAnother method will clone the existing instance of this type, including its internal member variables.

Reimplemented from itk::LightObject.

Reimplemented in itk::fem::LoadGravConst, itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::LoadLandmark, itk::fem::LoadTest< TClass >, and itk::fem::LoadPoint.

Element::ConstPointer itk::fem::LoadElement::GetElement

(

int

i

)

ElementPointersVectorType& itk::fem::LoadElement::GetElementArray ( )

inline

Definition at line 92 of file itkFEMLoadElementBase.h.

const ElementPointersVectorType& itk::fem::LoadElement::GetElementArray ( ) const

inline

Definition at line 97 of file itkFEMLoadElementBase.h.

virtual const char* itk::fem::LoadElement::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::fem::Load.

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

unsigned int itk::fem::LoadElement::GetNumberOfElements

(

)

static Pointer itk::fem::LoadElement::New ( )

static

Method for creation through the object factory.

virtual void itk::fem::LoadElement::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::Load.

Reimplemented in itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::LoadLandmark, itk::fem::LoadNoisyLandmark, itk::fem::LoadGravConst, itk::fem::LoadEdge, itk::fem::LoadPoint, and itk::fem::LoadGrav.

---

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

• itkFEMLoadElementBase.h