itk::fem::Solver< VDimension > Class Template Reference

#include <itkFEMSolver.h>

Inheritance diagram for itk::fem::Solver< VDimension >:

Collaboration diagram for itk::fem::Solver< VDimension >:

Detailed Description

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

FEM solver used to generate a solution for a FE formulation.

This class will solve the FE formulation provided in an FEMObject. The FEMObject contains the Elements, Material properties, Loads, and boundary conditions for the FE problem. The user can define properties of the solver including the time step using the SetTimeStep() method and the numerical solver via the SetLinearSystemWrapper() method. The output of the filter is the deformed FEMObject that also includes all of the loads and boundary conditions.

Inputs and Usage

The standard way to setup a FE problem in ITK is to use the following approach.

*       typedef itk::fem::FEMObject<3> FEMObjectType;
*       FEMObjectObjectType::Pointer fem = FEMObjectObjectType::New();
*       ...
*       typedef itk::fem::Solver<3> FEMSolverType;
*       FEMSolverType::Pointer solver = FEMSolverType::New();
*
*       solver->SetInput( fem );
*       solver->Update();
*       FEMSolverType::Pointer defem = solver->GetOutput();
*   ...
* 

The solution generated by the Solver can also be acquired using the GetSolution() method. The FEM can be saved in a file using the spatial objects and the Meta I/O library.

Definition at line 73 of file itkFEMSolver.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef Element::ArrayType	ElementArray
typedef FEMObjectType::ConstPointer	FEMObjectConstPointer
typedef FEMObjectType::Pointer	FEMObjectPointer
typedef itk::fem::FEMObject < VDimension >	FEMObjectType
typedef Element::Float	Float
typedef InterpolationGridType::DirectionType	InterpolationGridDirectionType
typedef InterpolationGridType::IndexType	InterpolationGridIndexType
typedef InterpolationGridType::Pointer	InterpolationGridPointerType
typedef InterpolationGridType::PointType	InterpolationGridPointType
typedef InterpolationGridType::RegionType	InterpolationGridRegionType
typedef InterpolationGridType::SizeType	InterpolationGridSizeType
typedef InterpolationGridType::SpacingType	InterpolationGridSpacingType
typedef itk::Image < Element::ConstPointer, VDimension >	InterpolationGridType
typedef Load::ArrayType	LoadArray
typedef Material::ArrayType	MaterialArray
typedef Element::Node::ArrayType	NodeArray
typedef SmartPointer< Self >	Pointer
typedef Solver	Self
typedef ProcessObject	Superclass
typedef Element::VectorType	VectorType
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef MultiThreader	MultiThreaderType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	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
virtual ::itk::LightObject::Pointer	CreateAnother () const
Float	GetDeformationEnergy (unsigned int SolutionIndex=0)
const Element *	GetElementAtPoint (const VectorType &pt) const
FEMObjectType *	GetInput ()
FEMObjectType *	GetInput (unsigned int idx)
LinearSystemWrapper::Pointer	GetLinearSystemWrapper ()
virtual const char *	GetNameOfClass () const
Float	GetSolution (unsigned int i, unsigned int which=0)
virtual Float	GetTimeStep () const
void	InitializeInterpolationGrid (const InterpolationGridSizeType &size, const InterpolationGridPointType &bb1, const InterpolationGridPointType &bb2)
virtual void	SetInput (FEMObjectType *fem)
virtual void	SetInput (unsigned int, FEMObjectType *fem)
void	SetLinearSystemWrapper (LinearSystemWrapper::Pointer ls)
virtual void	SetTimeStep (Float dt)
virtual void	SetOrigin (InterpolationGridPointType _arg)
virtual InterpolationGridPointType	GetOrigin ()
virtual void	SetSpacing (InterpolationGridSpacingType _arg)
virtual InterpolationGridSpacingType	GetSpacing ()
virtual void	SetRegion (InterpolationGridRegionType _arg)
virtual InterpolationGridRegionType	GetRegion ()
virtual void	SetDirection (InterpolationGridDirectionType _arg)
virtual InterpolationGridDirectionType	GetDirection ()
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
void	SetProgress (float progress)
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads () 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::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
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
unsigned int	m_NGFN
unsigned int	m_NMFC
LinearSystemWrapper::Pointer	m_LinearSystem
LinearSystemWrapperVNL	m_LinearSystemVNL
InterpolationGridPointerType	m_InterpolationGrid
FEMObjectPointer	m_FEMObject
InterpolationGridRegionType	m_Region
InterpolationGridPointType	m_Origin
InterpolationGridSpacingType	m_Spacing
InterpolationGridDirectionType	m_Direction
void	InitializeInterpolationGrid (const InterpolationGridSizeType &size)
void	InitializeInterpolationGrid (const InterpolationGridRegionType &region, const InterpolationGridPointType &origin, const InterpolationGridSpacingType &spacing, const InterpolationGridDirectionType &direction)
const InterpolationGridType *	GetInterpolationGrid (void) const
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType) override
FEMObjectType *	GetOutput ()
FEMObjectType *	GetOutput (unsigned int idx)
	Solver ()
virtual	~Solver () override
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	GenerateData () override
void	AssembleK ()
virtual void	InitializeMatrixForAssembly (unsigned int N)
virtual void	FinalizeMatrixAfterAssembly (void)
virtual void	AssembleElementMatrix (Element::Pointer e)
virtual void	AssembleLandmarkContribution (Element::ConstPointer e, float)
void	ApplyBC (int dim=0, unsigned int matrix=0)
void	AssembleF (int dim=0)
void	DecomposeK ()
virtual void	RunSolver ()
void	UpdateDisplacements ()
void	FillInterpolationGrid ()
virtual void	InitializeLinearSystemWrapper ()

Additional Inherited Members
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject () override
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object () 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 inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<unsigned int VDimension = 3>

typedef SmartPointer<const Self> itk::fem::Solver< VDimension >::ConstPointer

Definition at line 80 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef DataObject::Pointer itk::fem::Solver< VDimension >::DataObjectPointer

Definition at line 95 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef ProcessObject::DataObjectPointerArraySizeType itk::fem::Solver< VDimension >::DataObjectPointerArraySizeType

Make a DataObject of the correct type to be used as the specified output.

Definition at line 258 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef Element::ArrayType itk::fem::Solver< VDimension >::ElementArray

Definition at line 101 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef FEMObjectType::ConstPointer itk::fem::Solver< VDimension >::FEMObjectConstPointer

Definition at line 94 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef FEMObjectType::Pointer itk::fem::Solver< VDimension >::FEMObjectPointer

Definition at line 93 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef itk::fem::FEMObject<VDimension> itk::fem::Solver< VDimension >::FEMObjectType

Smart Pointer type to a DataObject.

Definition at line 92 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef Element::Float itk::fem::Solver< VDimension >::Float

Some convenient typedefs.

Definition at line 98 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef InterpolationGridType::DirectionType itk::fem::Solver< VDimension >::InterpolationGridDirectionType

Definition at line 115 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef InterpolationGridType::IndexType itk::fem::Solver< VDimension >::InterpolationGridIndexType

Definition at line 114 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef InterpolationGridType::Pointer itk::fem::Solver< VDimension >::InterpolationGridPointerType

Definition at line 109 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef InterpolationGridType::PointType itk::fem::Solver< VDimension >::InterpolationGridPointType

Definition at line 112 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef InterpolationGridType::RegionType itk::fem::Solver< VDimension >::InterpolationGridRegionType

Definition at line 111 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef InterpolationGridType::SizeType itk::fem::Solver< VDimension >::InterpolationGridSizeType

Definition at line 110 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef InterpolationGridType::SpacingType itk::fem::Solver< VDimension >::InterpolationGridSpacingType

Definition at line 113 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef itk::Image<Element::ConstPointer, VDimension> itk::fem::Solver< VDimension >::InterpolationGridType

Type used to store interpolation grid

Definition at line 108 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef Load::ArrayType itk::fem::Solver< VDimension >::LoadArray

Definition at line 102 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef Material::ArrayType itk::fem::Solver< VDimension >::MaterialArray

Definition at line 103 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef Element::Node::ArrayType itk::fem::Solver< VDimension >::NodeArray

Definition at line 100 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef SmartPointer<Self> itk::fem::Solver< VDimension >::Pointer

Definition at line 79 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef Solver itk::fem::Solver< VDimension >::Self

Standard class typedefs.

Definition at line 77 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef ProcessObject itk::fem::Solver< VDimension >::Superclass

Definition at line 78 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

typedef Element::VectorType itk::fem::Solver< VDimension >::VectorType

Definition at line 99 of file itkFEMSolver.h.

Constructor & Destructor Documentation

template<unsigned int VDimension = 3>

itk::fem::Solver< VDimension >::Solver ( )

protected

Make a DataObject of the correct type to be used as the specified output.

template<unsigned int VDimension = 3>

virtual itk::fem::Solver< VDimension >::~Solver ( )

overrideprotectedvirtual

Make a DataObject of the correct type to be used as the specified output.

Member Function Documentation

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::ApplyBC ( int  dim = 0, unsigned int  matrix = 0  )

protected

Apply the boundary conditions to the system.

Note

This function must be called after AssembleK().

Parameters

matrix	Index of a matrix, to which the BCs should be applied (master stiffness matrix). Normally this is zero, but in derived classes many matrices may be used and this index must be specified.
dim	This is a parameter that can be passed to the function and is normally used with isotropic elements to specify the dimension in which the DOF is fixed.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::AssembleElementMatrix ( Element::Pointer  e )

protectedvirtual

Copy the element stiffness matrix into the correct position in the master stiffess matrix. Since more complex Solver classes may need to assemble many matrices and may also do some funky stuff to them, this function is virtual and can be overriden in a derived solver class.

Reimplemented in itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::AssembleF ( int  dim = 0 )

protected

Assemble the master force vector.

Parameters

dim	This is a parameter that can be passed to the function and is normally used with isotropic elements to specify the dimension for which the master force vector should be assembled.

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::AssembleK ( )

protected

System solver functions. Call all six functions below (in listed order) to solve system. Assign a global freedom numbers to each DOF in a system. This must be done before any other solve function can be called.Assemble the master stiffness matrix (also apply the MFCs to K).

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::AssembleLandmarkContribution ( Element::ConstPointer  e, float    )

protectedvirtual

Add the contribution of the landmark-containing elements to the correct position in the master stiffess matrix. Since more complex Solver classes may need to assemble many matrices and may also do some funky stuff to them, this function is virtual and can be overriden in a derived solver class.

template<unsigned int VDimension = 3>

virtual::itk::LightObject::Pointer itk::fem::Solver< VDimension >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::DecomposeK ( )

protected

Decompose matrix using svd, qr, etc. if needed.

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::FillInterpolationGrid ( )

protected

Fill the interpolation grid based on the current deformed grid.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::FinalizeMatrixAfterAssembly ( void  )

inlineprotectedvirtual

This function is called after the assebly has been completed. In this class it is only used to apply the BCs. You may however use it to perform other stuff in derived solver classes.

Reimplemented in itk::fem::SolverHyperbolic< TDimension >.

Definition at line 315 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::GenerateData ( )

overrideprotectedvirtual

Method invoked by the pipeline in order to trigger the computation of the registration.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::fem::SolverCrankNicolson< TDimension >, itk::fem::RobustSolver< VDimension >, and itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

Float itk::fem::Solver< VDimension >::GetDeformationEnergy

(

unsigned int

SolutionIndex = 0

)

Get the total deformation energy using the chosen solution

template<unsigned int VDimension = 3>

virtual InterpolationGridDirectionType itk::fem::Solver< VDimension >::GetDirection ( )

virtual

Get/Set the interpolation grid direction.

template<unsigned int VDimension = 3>

const Element* itk::fem::Solver< VDimension >::GetElementAtPoint

(

const VectorType &

pt

)

const

Returns the pointer to the element which contains global point pt.

Parameters

pt	Point in global coordinate system.

Note

Interpolation grid must be initializes before you can call this function.

template<unsigned int VDimension = 3>

FEMObjectType* itk::fem::Solver< VDimension >::GetInput

(

)

template<unsigned int VDimension = 3>

FEMObjectType* itk::fem::Solver< VDimension >::GetInput

(

unsigned int

idx

)

template<unsigned int VDimension = 3>

const InterpolationGridType* itk::fem::Solver< VDimension >::GetInterpolationGrid ( void  ) const

inline

Returns pointer to interpolation grid, which is an itk::Image of pointers to Element objects. Normally you would use physical coordinates to get specific points (pointers to elements) from the image. You can then use the Elemenet::InterpolateSolution member function on the returned element to obtain the solution at this point.

Note

Physical coordinates in an image correspond to the global coordinate system in which the mesh (nodes) are.

Definition at line 250 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

LinearSystemWrapper::Pointer itk::fem::Solver< VDimension >::GetLinearSystemWrapper ( )

inline

Gets the LinearSystemWrapper object.

See Also

SetLinearSystemWrapper

Definition at line 195 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

virtual const char* itk::fem::Solver< VDimension >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

Reimplemented in itk::fem::RobustSolver< VDimension >, and itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

virtual InterpolationGridPointType itk::fem::Solver< VDimension >::GetOrigin ( )

virtual

Get/Set the interpolation grid Origin.

template<unsigned int VDimension = 3>

FEMObjectType* itk::fem::Solver< VDimension >::GetOutput

(

)

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

template<unsigned int VDimension = 3>

FEMObjectType* itk::fem::Solver< VDimension >::GetOutput

(

unsigned int

idx

)

Make a DataObject of the correct type to be used as the specified output.

template<unsigned int VDimension = 3>

virtual InterpolationGridRegionType itk::fem::Solver< VDimension >::GetRegion ( )

virtual

Get/Set the interpolation grid region.

template<unsigned int VDimension = 3>

Float itk::fem::Solver< VDimension >::GetSolution	(	unsigned int	i,
		unsigned int	which = 0
	)

Returns the Solution for the specified nodal point.

template<unsigned int VDimension = 3>

virtual InterpolationGridSpacingType itk::fem::Solver< VDimension >::GetSpacing ( )

virtual

Get/Set the interpolation grid spacing.

template<unsigned int VDimension = 3>

virtual Float itk::fem::Solver< VDimension >::GetTimeStep ( ) const

virtual

Returns the time step used for dynamic problems.

Reimplemented in itk::fem::SolverCrankNicolson< TDimension >, and itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::InitializeInterpolationGrid	(	const InterpolationGridSizeType &	size,
		const InterpolationGridPointType &	bb1,
		const InterpolationGridPointType &	bb2
	)

Initialize the interpolation grid. The interpolation grid is used to find elements that containg specific points in a mesh. The interpolation grid stores pointers to elements for each point on a grid thereby providing a fast way (lookup table) to perform interpolation of results.

Note

Interpolation grid must be reinitialized each time a mesh changes.

Parameters

size	Vector that represents number of points on a grid in each dimension.
bb1	Lower limit of a bounding box of a grid.
bb2	Upper limit of a bounding box of a grid.

See Also

GetInterpolationGrid

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::InitializeInterpolationGrid ( const InterpolationGridSizeType &  size )

inline

Same as InitializeInterpolationGrid(size, {0,0...}, size);

Definition at line 218 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::InitializeInterpolationGrid	(	const InterpolationGridRegionType &	region,
		const InterpolationGridPointType &	origin,
		const InterpolationGridSpacingType &	spacing,
		const InterpolationGridDirectionType &	direction
	)

Initialize the interpolation grid, over the domain specified by the user.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::InitializeLinearSystemWrapper ( )

protectedvirtual

Performs any initialization needed for LinearSystemWrapper object i.e. sets the maximum number of matrices and vectors.

Reimplemented in itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::InitializeMatrixForAssembly ( unsigned int  N )

protectedvirtual

This function is called before assembling the matrices. You can override it in a derived class to account for special needs.

Parameters

N	Size of the matrix.

Reimplemented in itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

virtual DataObjectPointer itk::fem::Solver< VDimension >::MakeOutput ( DataObjectPointerArraySizeType  )

overridevirtual

Make a DataObject of the correct type to be used as the specified output.

Reimplemented from itk::ProcessObject.

template<unsigned int VDimension = 3>

static Pointer itk::fem::Solver< VDimension >::New ( )

static

Method for creation through the object factory.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Make a DataObject of the correct type to be used as the specified output.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::RunSolver ( )

protectedvirtual

Solve for the displacement vector u. May be overriden in derived classes.

Reimplemented in itk::fem::SolverCrankNicolson< TDimension >, itk::fem::RobustSolver< VDimension >, and itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::SetDirection ( InterpolationGridDirectionType  _arg )

virtual

Get/Set the interpolation grid direction.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::SetInput ( FEMObjectType *  fem )

virtual

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::SetInput ( unsigned  int, FEMObjectType *  fem  )

virtual

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::SetLinearSystemWrapper

(

LinearSystemWrapper::Pointer

ls

)

Sets the LinearSystemWrapper object that will be used when solving the master equation. If this function is not called, a default VNL linear system representation will be used (class LinearSystemWrapperVNL).

Parameters

ls	Pointer to an object of class which is derived from LinearSystemWrapper.

Note

Once the LinearSystemWrapper object is changed, it is used until the member function SetLinearSystemWrapper is called again. Since LinearSystemWrapper object was created outside the Solver class, it should also be destroyed outside. Solver class will not destroy it when the Solver object is destroyed.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::SetOrigin ( InterpolationGridPointType  _arg )

virtual

Get/Set the interpolation grid Origin.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::SetRegion ( InterpolationGridRegionType  _arg )

virtual

Get/Set the interpolation grid region.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::SetSpacing ( InterpolationGridSpacingType  _arg )

virtual

Get/Set the interpolation grid spacing.

template<unsigned int VDimension = 3>

virtual void itk::fem::Solver< VDimension >::SetTimeStep ( Float  dt )

virtual

Sets the time step used for dynamic problems.

Parameters

dt	New time step.

Reimplemented in itk::fem::SolverCrankNicolson< TDimension >, and itk::fem::SolverHyperbolic< TDimension >.

template<unsigned int VDimension = 3>

void itk::fem::Solver< VDimension >::UpdateDisplacements ( )

protected

Copy solution vector u to the corresponding nodal values, which are stored in node objects). This is standard post processing of the solution.

Member Data Documentation

template<unsigned int VDimension = 3>

const unsigned int itk::fem::Solver< VDimension >::FEMDimension = VDimension

static

Definition at line 88 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

InterpolationGridDirectionType itk::fem::Solver< VDimension >::m_Direction

private

Make a DataObject of the correct type to be used as the specified output.

Definition at line 415 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

FEMObjectPointer itk::fem::Solver< VDimension >::m_FEMObject

protected

Make a DataObject of the correct type to be used as the specified output.

Definition at line 406 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

InterpolationGridPointerType itk::fem::Solver< VDimension >::m_InterpolationGrid

protected

An Image of pointers to Element objects that represents a grid used for interpolation of solution. Each Pixel in an image is a pointer to an Element object in which that pixel is located.

Definition at line 404 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

LinearSystemWrapper::Pointer itk::fem::Solver< VDimension >::m_LinearSystem

protected

Pointer to LinearSystemWrapper object.

Definition at line 394 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

LinearSystemWrapperVNL itk::fem::Solver< VDimension >::m_LinearSystemVNL

protected

LinearSystemWrapperVNL object that is used by default in Solver class.

Definition at line 397 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

unsigned int itk::fem::Solver< VDimension >::m_NGFN

protected

Number of global degrees of freedom in a system.

Definition at line 385 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

unsigned int itk::fem::Solver< VDimension >::m_NMFC

protected

Number of multi freedom constraints in a system. This member is set in a AssembleK function.

Definition at line 391 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

InterpolationGridPointType itk::fem::Solver< VDimension >::m_Origin

private

Make a DataObject of the correct type to be used as the specified output.

Definition at line 413 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

InterpolationGridRegionType itk::fem::Solver< VDimension >::m_Region

private

Properties of the interpolation grid.

Definition at line 409 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

InterpolationGridSpacingType itk::fem::Solver< VDimension >::m_Spacing

private

Make a DataObject of the correct type to be used as the specified output.

Definition at line 414 of file itkFEMSolver.h.

template<unsigned int VDimension = 3>

const unsigned int itk::fem::Solver< VDimension >::MaxDimensions = 3

static

Definition at line 89 of file itkFEMSolver.h.

---

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

• itkFEMSolver.h