itk::fem::LoadPoint Class Reference

#include <itkFEMLoadPoint.h>

Inheritance diagram for itk::fem::LoadPoint:

[legend]Collaboration diagram for itk::fem::LoadPoint:

[legend]List of all members.

---

Detailed Description

This load is applied on a point in an element.

FIXME: To be implemented. Nothing works yet

Definition at line 36 of file itkFEMLoadPoint.h.

Public Types
typedef FEMPArray< Self >	ArrayType
typedef Self	Baseclass
typedef const Self *	ConstPointer
typedef std::vector< Element::ConstPointer >	ElementPointersVectorType
typedef Element::Float	Float
typedef Self *	Pointer
typedef LoadPoint	Self
typedef LoadElement	Superclass
Public Member Functions
virtual int	ClassID () const
virtual Baseclass::Pointer	Clone () const
virtual Solution::ConstPointer	GetSolution ()
virtual void	Read (std::istream &f, void *info)
*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 and store the passed pointer accordingly If the result *vector is not the functionn should be left *so that only the dummy implementation in base class is called **param ptr Pointer to the object of Solution class *virtual void	SetSolution (Solution::ConstPointer)
void	Write (std::ostream &f) const
Static Public Member Functions
static FEMLightObject::Pointer	CreateFromStream (std::istream &f, void *info)
static Self::Pointer	New ()
static void	SkipWhiteSpace (std::istream &f)
Public Attributes
vnl_vector< Float >	Fp
*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
int	GN
vnl_vector< Float >	point
*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 and store the passed pointer accordingly If the result *vector is not	required
*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 and store the passed pointer accordingly If the result *vector is not the functionn should be left	unimplemented
Static Public Attributes
static const int	CLID
static const std::string	whitespaces

---

Member Typedef Documentation

typedef FEMPArray<Self> itk::fem::Load::ArrayType [inherited]

Array class that holds special pointers to the load objects Definition at line 45 of file itkFEMLoadBase.h.

typedef Self itk::fem::FEMLightObject::Baseclass [inherited]

Store the base class typedef for easy access from derived classes. FEM_CLASS macro also expects this for the FEMOF... Definition at line 67 of file itkFEMLightObject.h.

typedef const Self* itk::fem::LoadPoint::ConstPointer

Const pointer or SmartPointer to an object. Reimplemented from itk::fem::LoadElement. Definition at line 37 of file itkFEMLoadPoint.h.

typedef std::vector<Element::ConstPointer> itk::fem::LoadElement::ElementPointersVectorType [inherited]

Type of array of pointers to element objects Definition at line 57 of file itkFEMLoadElementBase.h.

typedef Element::Float itk::fem::LoadElement::Float [inherited]

Float type used in Element and derived classes Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, and itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >. Definition at line 52 of file itkFEMLoadElementBase.h.

typedef Self* itk::fem::LoadPoint::Pointer

Pointer or SmartPointer to an object. Reimplemented from itk::fem::LoadElement. Definition at line 37 of file itkFEMLoadPoint.h.

typedef LoadPoint itk::fem::LoadPoint::Self

Standard Self typedef. Reimplemented from itk::fem::LoadElement. Definition at line 37 of file itkFEMLoadPoint.h.

typedef LoadElement itk::fem::LoadPoint::Superclass

Standard Superclass typedef. Reimplemented from itk::fem::LoadElement. Definition at line 37 of file itkFEMLoadPoint.h.

---

Member Function Documentation

virtual int itk::fem::LoadPoint::ClassID (   )  const [inline, virtual]

Virtual function to access the class ID Reimplemented from itk::fem::LoadElement. Definition at line 37 of file itkFEMLoadPoint.h.

virtual Baseclass::Pointer itk::fem::LoadPoint::Clone (   )  const [virtual]

Create a new object from the existing one Reimplemented from itk::fem::LoadElement.

static FEMLightObject::Pointer itk::fem::FEMLightObject::CreateFromStream (  std::istream &  f, void *  info )  [static, inherited]

Read object of any derived type from stream. This static function creates an object of a class, which is derived from FEMLightObject. The class of object is first determined from the stream, then the object of that class is constructed using the FEMObjectFactory. Finally the data for this object is read from the stream, by calling the Read() member function.

virtual Solution::ConstPointer itk::fem::Load::GetSolution (   )  [inline, virtual, inherited]

Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadLandmark, and itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >. Definition at line 60 of file itkFEMLoadBase.h.

static Self::Pointer itk::fem::LoadPoint::New (  void   )  [inline, static]

Object creation in an itk compatible way Reimplemented from itk::fem::LoadElement. Definition at line 37 of file itkFEMLoadPoint.h.

virtual void itk::fem::LoadElement::Read (  std::istream &  f, void *  info )  [virtual, inherited]

pointers to element objects on which the load acts Reimplemented from itk::fem::FEMLightObject. Reimplemented in itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, and itk::fem::LoadTest< TClass >. Referenced by itk::fem::LoadTest< TClass >::Read().

* 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 and store the passed pointer accordingly If the result* vector is not the functionn should be left * so that only the dummy implementation in base class is called* * param ptr Pointer to the object of Solution class* virtual void itk::fem::Load::SetSolution (  Solution::ConstPointer   )  [inline, virtual, inherited]

Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadLandmark, and itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >. Definition at line 59 of file itkFEMLoadBase.h.

static void itk::fem::FEMLightObject::SkipWhiteSpace (  std::istream &  f  )  [static, inherited]

Helper function that skips all the whitespace and comments in an input stream.

void itk::fem::LoadElement::Write (  std::ostream &  f  )  const [virtual, inherited]

Write an object to the output stream. Call this member to write the data members in the current object to the output stream. Here we also need to know which derived class we actually are, so that we can write the class name. The class name is obtained by calling the virtual ClassID() member function and passing the result to the FEMObjectFactory. Implementations of Write member funtion in derived classes should first call the parent's implementation of Write and finaly write whatever they need. Reimplemented from itk::fem::FEMLightObject. Reimplemented in itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, and itk::fem::LoadTest< TClass >. Referenced by itk::fem::LoadTest< TClass >::Write().

---

Member Data Documentation

const int itk::fem::LoadPoint::CLID [static]

Class ID for FEM object factory Reimplemented from itk::fem::LoadElement. Definition at line 37 of file itkFEMLoadPoint.h.

vnl_vector<Float> itk::fem::LoadPoint::Fp

the actual load vector Definition at line 48 of file itkFEMLoadPoint.h.

* 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 itk::fem::Load::function [inherited]

Definition at line 52 of file itkFEMLoadBase.h.

int itk::fem::FEMLightObject::GN [inherited]

Global number of an object (ID of an object) In general the ID's are required to be unique only within a specific type of derived classes (Elements, Nodes, ...) If the GN is not required, it can be ignored. (normally you need the GN when writing or reading objects to/from stream. Definition at line 168 of file itkFEMLightObject.h. Referenced by itk::fem::FEMLightObject::FEMLightObject().

vnl_vector<Float> itk::fem::LoadPoint::point

Point of which the load acts in global coord. sys. Definition at line 43 of file itkFEMLoadPoint.h.

* 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 and store the passed pointer accordingly If the result* vector is not itk::fem::Load::required [inherited]

Definition at line 52 of file itkFEMLoadBase.h.

* 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 and store the passed pointer accordingly If the result* vector is not the functionn should be left itk::fem::Load::unimplemented [inherited]

Definition at line 52 of file itkFEMLoadBase.h.

const std::string itk::fem::FEMLightObject::whitespaces [static, inherited]

Const string of all whitespace characters. This string is used by SkipWhiteSpace function. Definition at line 138 of file itkFEMLightObject.h.

---

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

• itkFEMLoadPoint.h

---