itk::fem::SolverHyperbolic< TDimension > Class Template Reference

#include <itkFEMSolverHyperbolic.h>

Inheritance diagram for itk::fem::SolverHyperbolic< TDimension >:

Collaboration diagram for itk::fem::SolverHyperbolic< TDimension >:

Detailed Description

template<unsigned int TDimension = 3>
class itk::fem::SolverHyperbolic< TDimension >

Solver class suitable for hyperbolic problems.

M*ddu + C*du + K*u=F.

Definition at line 36 of file itkFEMSolverHyperbolic.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Element::Float	Float
typedef SmartPointer< Self >	Pointer
typedef SolverHyperbolic	Self
typedef Solver< TDimension >	Superclass
Public Types inherited from itk::fem::Solver< TDimension >
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
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
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
virtual const char *	GetNameOfClass () const
virtual Float	GetTimeStep (void) const override
virtual void	SetTimeStep (Float dt) override
virtual void	SetGamma (Float _arg)
virtual Float	GetGamma ()
virtual void	SetBeta (Float _arg)
virtual Float	GetBeta ()
virtual void	SetNumberOfIterations (unsigned int _arg)
virtual unsigned int	GetNumberOfIterations ()
Public Member Functions inherited from itk::fem::Solver< TDimension >
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 ()
Float	GetSolution (unsigned int i, unsigned int which=0)
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	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 ()
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)
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::fem::Solver< TDimension >
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 ()

Protected Types
enum	{   matrix_K =1,   matrix_M =2,   matrix_C =3,   matrix_tmp =4 }
enum	{   solution_d =0,   solution_v =1,   solution_a =2 }
enum	{   vector_dhat =2,   vector_vhat =3,   vector_ahat =4,   vector_tmp =5 }

Protected Member Functions
virtual void	AssembleElementMatrix (Element::Pointer e) override
virtual void	FinalizeMatrixAfterAssembly (void) override
void	GenerateData () override
virtual void	InitializeLinearSystemWrapper (void) override
virtual void	InitializeMatrixForAssembly (unsigned int N) override
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	RunSolver (void) override
void	Solve ()
	SolverHyperbolic ()
virtual	~SolverHyperbolic () override
Protected Member Functions inherited from itk::fem::Solver< TDimension >
	Solver ()
virtual	~Solver () override
void	AssembleK ()
virtual void	AssembleLandmarkContribution (Element::ConstPointer e, float)
void	ApplyBC (int dim=0, unsigned int matrix=0)
void	AssembleF (int dim=0)
void	DecomposeK ()
void	UpdateDisplacements ()
void	FillInterpolationGrid ()
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
Float	m_Beta
Float	m_Gamma
unsigned int	m_NumberOfIterations
Float	m_TimeStep
Protected Attributes inherited from itk::fem::Solver< TDimension >
unsigned int	m_NGFN
unsigned int	m_NMFC
LinearSystemWrapper::Pointer	m_LinearSystem
LinearSystemWrapperVNL	m_LinearSystemVNL
InterpolationGridPointerType	m_InterpolationGrid
FEMObjectPointer	m_FEMObject
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Additional Inherited Members
Static Public Attributes inherited from itk::fem::Solver< TDimension >
static const unsigned int	FEMDimension
static const unsigned int	MaxDimensions

Member Typedef Documentation

template<unsigned int TDimension = 3>

typedef SmartPointer<const Self> itk::fem::SolverHyperbolic< TDimension >::ConstPointer

Definition at line 42 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

typedef Element::Float itk::fem::SolverHyperbolic< TDimension >::Float

Definition at line 48 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

typedef SmartPointer<Self> itk::fem::SolverHyperbolic< TDimension >::Pointer

Definition at line 41 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

typedef SolverHyperbolic itk::fem::SolverHyperbolic< TDimension >::Self

Definition at line 39 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

typedef Solver<TDimension> itk::fem::SolverHyperbolic< TDimension >::Superclass

Definition at line 40 of file itkFEMSolverHyperbolic.h.

Member Enumeration Documentation

template<unsigned int TDimension = 3>

anonymous enum

protected

Constants that specify where matrices are strored.

Enumerator
matrix_K
matrix_M
matrix_C
matrix_tmp

Definition at line 118 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

anonymous enum

protected

Constants that specify where vectors are strored.

Enumerator
solution_d
solution_v
solution_a

Definition at line 121 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

anonymous enum

protected

Enumerator
vector_dhat
vector_vhat
vector_ahat
vector_tmp

Definition at line 122 of file itkFEMSolverHyperbolic.h.

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>

itk::fem::SolverHyperbolic< TDimension >::SolverHyperbolic ( )

protected

template<unsigned int TDimension = 3>

virtual itk::fem::SolverHyperbolic< TDimension >::~SolverHyperbolic ( )

inlineoverrideprotectedvirtual

Definition at line 85 of file itkFEMSolverHyperbolic.h.

Member Function Documentation

template<unsigned int TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::AssembleElementMatrix ( Element::Pointer  e )

overrideprotectedvirtual

When assembling the element matrix into master matrix, we need to assemble the mass matrix too.

Reimplemented from itk::fem::Solver< TDimension >.

template<unsigned int TDimension = 3>

virtual::itk::LightObject::Pointer itk::fem::SolverHyperbolic< TDimension >::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 TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::FinalizeMatrixAfterAssembly ( void  )

overrideprotectedvirtual

Combine the M, C and K matrices into one big system of linear equations.

Reimplemented from itk::fem::Solver< TDimension >.

template<unsigned int TDimension = 3>

void itk::fem::SolverHyperbolic< TDimension >::GenerateData ( )

overrideprotectedvirtual

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

Reimplemented from itk::fem::Solver< TDimension >.

template<unsigned int TDimension = 3>

virtual Float itk::fem::SolverHyperbolic< TDimension >::GetBeta ( )

virtual

Get/Set Beta.

template<unsigned int TDimension = 3>

virtual Float itk::fem::SolverHyperbolic< TDimension >::GetGamma ( )

virtual

Get/Set Gamma.

template<unsigned int TDimension = 3>

virtual const char* itk::fem::SolverHyperbolic< TDimension >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::fem::Solver< TDimension >.

template<unsigned int TDimension = 3>

virtual unsigned int itk::fem::SolverHyperbolic< TDimension >::GetNumberOfIterations ( )

virtual

Get/Set Number of Iterations.

template<unsigned int TDimension = 3>

virtual Float itk::fem::SolverHyperbolic< TDimension >::GetTimeStep ( void  ) const

inlineoverridevirtual

Returns the time step used for dynamic problems.

Reimplemented from itk::fem::Solver< TDimension >.

Definition at line 68 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::InitializeLinearSystemWrapper ( void  )

overrideprotectedvirtual

Initialize the linear system wrapper.

Reimplemented from itk::fem::Solver< TDimension >.

template<unsigned int TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::InitializeMatrixForAssembly ( unsigned int  N )

overrideprotectedvirtual

Initialize the storage for all master matrices.

Reimplemented from itk::fem::Solver< TDimension >.

template<unsigned int TDimension = 3>

static Pointer itk::fem::SolverHyperbolic< TDimension >::New ( )

static

Method for creation through the object factory.

template<unsigned int TDimension = 3>

void itk::fem::SolverHyperbolic< TDimension >::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::fem::Solver< TDimension >.

template<unsigned int TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::RunSolver ( void  )

overrideprotectedvirtual

Solve for the displacement vector u at a given time. Update the total solution as well.

Reimplemented from itk::fem::Solver< TDimension >.

template<unsigned int TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::SetBeta ( Float  _arg )

virtual

Get/Set Beta.

template<unsigned int TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::SetGamma ( Float  _arg )

virtual

Get/Set Gamma.

template<unsigned int TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::SetNumberOfIterations ( unsigned int  _arg )

virtual

Get/Set Number of Iterations.

template<unsigned int TDimension = 3>

virtual void itk::fem::SolverHyperbolic< TDimension >::SetTimeStep ( Float  dt )

inlineoverridevirtual

Sets the time step used for the problems.

Parameters

dt	New time step.

Reimplemented from itk::fem::Solver< TDimension >.

Definition at line 78 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

void itk::fem::SolverHyperbolic< TDimension >::Solve ( )

protected

Solve for the displacement vector u for one iteration.

Member Data Documentation

template<unsigned int TDimension = 3>

Float itk::fem::SolverHyperbolic< TDimension >::m_Beta

protected

Definition at line 126 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

Float itk::fem::SolverHyperbolic< TDimension >::m_Gamma

protected

Definition at line 125 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

unsigned int itk::fem::SolverHyperbolic< TDimension >::m_NumberOfIterations

protected

Definition at line 127 of file itkFEMSolverHyperbolic.h.

template<unsigned int TDimension = 3>

Float itk::fem::SolverHyperbolic< TDimension >::m_TimeStep

protected

Definition at line 124 of file itkFEMSolverHyperbolic.h.

---

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

• itkFEMSolverHyperbolic.h