Detailed Description

template<unsigned int VDimension = 3>
class itk::fem::FEMObject< VDimension >

Implements N-dimensional Finite element (FE) models including elements, materials, and loads.

Overview: FEMObject was created to provide an object in ITK that specifies the entire FE model. This model can then be passed to the itk::fem::Solver to generate a solution for the model. The design for this class was modelled after the itk::Mesh structure. Presently, no direct I/O support for the FEMObject exists. This must be done using the FEMSpatialObject. The FEMObject simply serves as a storage container for the FE model.

The FEMObject stores the FE problem using Vector Containers for 1) Load 2) Material 3) Element 4) Node

Usage: The user can set the Vector Containers that define the Load, Material, Element, and Nodes using the AddNext<Object> and Insert<Object> methods. The user can also get the entire VectorContainer using the Get<Object>Container(). For convience methods are also provided to get any item in the vector containers based on their index (Get<Object>) or their global number (Get<Object>WithGlobalNumber). This class does not know anything about the types of elements, materials, elements, or nodes. The problem presently can only be 2D or 3D.

Examples:: Examples/RegistrationITKv3/DeformableRegistration1.cxx, Examples/RegistrationITKv3/DeformableRegistration11.cxx, Examples/RegistrationITKv4/DeformableRegistration1.cxx, and Examples/RegistrationITKv4/DeformableRegistration11.cxx.

Definition at line 75 of file itkFEMObject.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef ElementContainerType::ConstIterator	ElementContainerConstIterator

typedef ElementContainerType::ConstPointer	ElementContainerConstPointer

typedef ElementContainerType::Iterator	ElementContainerIterator

typedef ElementContainerType::Pointer	ElementContainerPointer

typedef VectorContainer < ElementIdentifier, Element::Pointer >	ElementContainerType

typedef unsigned long	ElementIdentifier

typedef LoadContainerType::ConstIterator	LoadContainerConstIterator

typedef LoadContainerType::ConstPointer	LoadContainerConstPointer

typedef LoadContainerType::Iterator	LoadContainerIterator

typedef LoadContainerType::Pointer	LoadContainerPointer

typedef VectorContainer < LoadIdentifier, Load::Pointer >	LoadContainerType

typedef unsigned long	LoadIdentifier

typedef MaterialContainerType::ConstIterator	MaterialContainerConstIterator

typedef MaterialContainerType::ConstPointer	MaterialContainerConstPointer

typedef MaterialContainerType::Iterator	MaterialContainerIterator

typedef MaterialContainerType::Pointer	MaterialContainerPointer

typedef VectorContainer < MaterialIdentifier, Material::Pointer >	MaterialContainerType

typedef unsigned long	MaterialIdentifier

typedef NodeContainerType::ConstIterator	NodeContainerConstIterator

typedef NodeContainerType::ConstPointer	NodeContainerConstPointer

typedef NodeContainerType::Iterator	NodeContainerIterator

typedef NodeContainerType::Pointer	NodeContainerPointer

typedef VectorContainer < NodeIdentifier, Element::Node::Pointer >	NodeContainerType

typedef unsigned long	NodeIdentifier

typedef SmartPointer< Self >	Pointer

typedef FEMObject	Self

typedef DataObject	Superclass

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

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef 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::Pointer e)

void	AddNextLoad (Load::Pointer ld)

void	AddNextLoad (LoadNode::Pointer ld)

void	AddNextLoad (LoadBCMFC::Pointer ld)

void	AddNextLoad (LoadBC::Pointer ld)

void	AddNextLoad (LoadEdge::Pointer ld)

void	AddNextLoad (LoadGravConst::Pointer ld)

void	AddNextLoad (LoadLandmark::Pointer ld)

void	AddNextMaterial (Material::Pointer mat)

void	AddNextMaterial (MaterialLinearElasticity::Pointer mat)

void	AddNextNode (Element::Node::Pointer e)

void	Clear ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

void	DeepCopy (FEMObject *Copy)

void	FinalizeMesh ()

virtual const ElementContainerType *	GetElementContainer () const

virtual const LoadContainerType *	GetLoadContainer () const

Load::Pointer	GetLoadWithGlobalNumber (int globalNumber)

virtual const MaterialContainerType *	GetMaterialContainer () const

virtual ElementContainerType *	GetModifiableElementContainer ()

virtual LoadContainerType *	GetModifiableLoadContainer ()

virtual MaterialContainerType *	GetModifiableMaterialContainer ()

virtual NodeContainerType *	GetModifiableNodeContainer ()

virtual const char *	GetNameOfClass () const

virtual const NodeContainerType *	GetNodeContainer () const

Element::Node::Pointer	GetNodeWithGlobalNumber (int globalNumber)

unsigned int	GetNumberOfDegreesOfFreedom (void) const

unsigned int	GetNumberOfElements (void) const

unsigned int	GetNumberOfLoads (void) const

unsigned int	GetNumberOfMaterials (void) const

unsigned int	GetNumberOfMultiFreedomConstraints (void) const

unsigned int	GetNumberOfNodes (void) const

void	InsertElement (Element::Pointer e, ElementIdentifier index)

void	InsertLoad (Load::Pointer ld, LoadIdentifier index)

void	InsertMaterial (Material::Pointer e, MaterialIdentifier index)

void	InsertNode (Element::Node::Pointer e, NodeIdentifier index)

void	RenumberNodeContainer ()


Element::ConstPointer	GetElement (ElementIdentifier index) const

Element::Pointer	GetElement (ElementIdentifier index)


Element::ConstPointer	GetElementWithGlobalNumber (int globalNumber) const

Element::Pointer	GetElementWithGlobalNumber (int globalNumber)


Element::Node::Pointer	GetNode (NodeIdentifier index)

Element::Node::ConstPointer	GetNode (NodeIdentifier index) const


Material::ConstPointer	GetMaterial (MaterialIdentifier index) const

Material::Pointer	GetMaterial (MaterialIdentifier index)


Material::ConstPointer	GetMaterialWithGlobalNumber (int globalNumber) const

Material::Pointer	GetMaterialWithGlobalNumber (int globalNumber)


Load::ConstPointer	GetLoad (LoadIdentifier index) const

Load::Pointer	GetLoad (LoadIdentifier index)

Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)

virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointerForwardReference < ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

virtual void	Initialize ()

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

virtual void	SetRequestedRegion (const DataObject *)

virtual void	SetRequestedRegionToLargestPossibleRegion ()

bool	ShouldIReleaseData () const

virtual void	Update ()

virtual void	UpdateOutputData ()

virtual void	UpdateOutputInformation ()

virtual bool	VerifyRequestedRegion ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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

static Pointer	New ()

Static Public Attributes
static const unsigned int	FEMDimension = VDimension

static const unsigned int	MaxDimensions = 3

Protected Member Functions
void	AddNextMaterialInternal (Material *mat)

void	GenerateGFN ()

void	GenerateMFC ()


	FEMObject ()

	~FEMObject ()

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

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~DataObject ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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
ElementContainerPointer	m_ElementContainer

LoadContainerPointer	m_LoadContainer

MaterialContainerPointer	m_MaterialContainer

unsigned int	m_NGFN

unsigned int	m_NMFC

NodeContainerPointer	m_NodeContainer

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Member Functions
void	AddNextLoadInternal (Load *l)

	FEMObject (const Self &) ITK_DELETE_FUNCTION

void	operator= (const Self &) ITK_DELETE_FUNCTION