itk::fem::LoadEdge Class Reference

#include <itkFEMLoadEdge.h>

Inheritance diagram for itk::fem::LoadEdge:

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

[legend]List of all members.

Detailed Description

A generic load that can be applied to an edge of the element.

Can also be used to apply natural (Neumann) boundary condition on the edge of the element. In this case m_Edge defines the edge or surfance of the element on which the BC exists and matrix m_Force holds the actual prescribed values of the BC.

Definition at line 39 of file itkFEMLoadEdge.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 LoadEdge 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)

virtual 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

*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

int m_Edge

vnl_matrix< Float > m_Force

*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::LoadEdge::ConstPointer

Const pointer or SmartPointer to an object.
Reimplemented from itk::fem::LoadElement.
Definition at line 41 of file itkFEMLoadEdge.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::LoadEdge::Pointer

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

typedef LoadEdge itk::fem::LoadEdge::Self

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

typedef LoadElement itk::fem::LoadEdge::Superclass

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

Member Function Documentation

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

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

virtual Baseclass::Pointer itk::fem::LoadEdge::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::LoadEdge::New ( void ) [inline, static]

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

virtual void itk::fem::LoadEdge::Read ( std::istream & f,

void * info

) [virtual]

Read a Load object from input stream. We need arrays of elements and nodes to do that.
Reimplemented from itk::fem::LoadElement.

* 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.

virtual void itk::fem::LoadEdge::Write ( std::ostream & f ) const [virtual]

Write a Load object to the output stream
Reimplemented from itk::fem::LoadElement.

Member Data Documentation

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

Class ID for FEM object factory
Reimplemented from itk::fem::LoadElement.
Definition at line 41 of file itkFEMLoadEdge.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().

int itk::fem::LoadEdge::m_Edge

Local number of the edge (face) of the element on which the load acts. Check the corresponding element class for more info on edge numbering.
Definition at line 60 of file itkFEMLoadEdge.h.

vnl_matrix<Float> itk::fem::LoadEdge::m_Force

An edge force matrix. This matrix specifies nodal forces on all nodes within the edge or face on which the load acts. Each nodal force is decomposed into several components (check the documentation inside the element class). In case of 2D elements this components are normal (1st component) and tangential (2nd component) force acting on the edge of the element. A positive normal load acts in a direction INTO the element. A positive tangential load acts in an ANTICLOCKWISE direction with respect to the loaded elemenet. Each nodal force is stored in a column of the matrix. The number of columns in the Force matrix must correspond to the number of nodes that define the edge (face...). The force is interpolated over the entire edge (face) by using the shape functions of the element. Again check the documentation of the element class to which the force is applied.
Definition at line 78 of file itkFEMLoadEdge.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:

itkFEMLoadEdge.h

Generated at Sun Jul 9 23:47:51 2006 for ITK by


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 LoadEdge	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)
virtual 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
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
int	m_Edge
vnl_matrix< Float >	m_Force
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