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

#include <itkFEMLoadEdge.h>

Inheritance diagram for itk::fem::LoadEdge:

Collaboration diagram for itk::fem::LoadEdge:

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)
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
ElementPointersVectorType	el
int	GN
int	m_Edge
vnl_matrix< Float >	m_Force

Static Public Attributes
static const int	CLID
static const std::string	whitespaces = " \t\n\r"

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 36 of file itkFEMLoadEdge.h.

Member Typedef Documentation

typedef FEMPArray<Self> itk::fem::Load::ArrayType

inherited

Array class that holds special pointers to the load objects

Definition at line 42 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 62 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 38 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 53 of file itkFEMLoadElementBase.h.

typedef Element::Float itk::fem::LoadElement::Float

inherited

Float type used in Element and derived classes

Reimplemented in itk::fem::ImageMetricLoad< TMoving, TFixed >, and itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >.

Definition at line 48 of file itkFEMLoadElementBase.h.

typedef Self* itk::fem::LoadEdge::Pointer

Pointer or SmartPointer to an object.

Reimplemented from itk::fem::LoadElement.

Definition at line 38 of file itkFEMLoadEdge.h.

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

Standard Self typedef.

Reimplemented from itk::fem::LoadElement.

Definition at line 38 of file itkFEMLoadEdge.h.

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

Standard Superclass typedef.

Reimplemented from itk::fem::LoadElement.

Definition at line 38 of file itkFEMLoadEdge.h.

Member Function Documentation

virtual int itk::fem::LoadEdge::ClassID ( ) const

inlinevirtual

Virtual function to access the class ID

Reimplemented from itk::fem::LoadElement.

Definition at line 38 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.

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

staticinherited

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.

Read and create object of any derived class from stream

 Catch possible exceptions while 
 reading object's data from stream

 Return a pointer to a newly created object if all was OK
 Technically everithing should be fine here (a!=0), but we
 check again, just in case.

 Something went wrong.
 Reset the stream position to where it was before reading the object.

Definition at line 77 of file itkFEMLightObject.cxx.

References itk::fem::FEMObjectFactory< FEMLightObject >::ClassName2ID(), itk::fem::FEMObjectFactory< FEMLightObject >::Create(), itk::fem::FEMLightObject::Read(), itk::fem::FEMLightObject::SkipWhiteSpace(), and itk::fem::FEMLightObject::whitespaces.

Referenced by itk::fem::Solver::Read().

virtual Solution::ConstPointer itk::fem::Load::GetSolution ( )

inlinevirtualinherited

Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, and itk::fem::LoadLandmark.

Definition at line 57 of file itkFEMLoadBase.h.

static Self::Pointer itk::fem::LoadEdge::New ( void )

inlinestatic

Object creation in an itk compatible way

Reimplemented from itk::fem::LoadElement.

Definition at line 38 of file itkFEMLoadEdge.h.

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.

Read the Load object from input stream

first call the parent's read function

... edge number

... # of rows

... # of cols

Reimplemented from itk::fem::LoadElement.

Definition at line 31 of file itkFEMLoadEdge.cxx.

References m_Edge, m_Force, itk::fem::LoadElement::Read(), and itk::fem::FEMLightObject::SkipWhiteSpace().

virtual void itk::fem::Load::SetSolution ( Solution::ConstPointer )

inlinevirtualinherited

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, and store the passed pointer accordingly. If the result vector is not required, the functionn should be left unimplemented, so that only the dummy implementation in base class is called.

Parameters:

ptr	Pointer to the object of Solution class.

Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, and itk::fem::LoadLandmark.

Definition at line 56 of file itkFEMLoadBase.h.

void itk::fem::FEMLightObject::SkipWhiteSpace ( std::istream & f )

staticinherited

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

Definition at line 189 of file itkFEMLightObject.cxx.

Referenced by itk::fem::FEMLightObject::CreateFromStream(), itk::fem::MaterialLinearElasticity::Read(), Read(), itk::fem::LoadNode::Read(), itk::fem::LoadElement::Read(), itk::fem::LoadBC::Read(), itk::fem::LoadGravConst::Read(), itk::fem::FEMLightObject::Read(), itk::fem::LoadBCMFC::Read(), itk::fem::LoadLandmark::Read(), itk::fem::Element::Node::Read(), and itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::ReadConfigFile().

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

virtual

Write a Load object to the output stream

Write the Load object to the output stream

first call the parent's write function

Write the actual Load data

... edge number

... force matrix

check for errors

Reimplemented from itk::fem::LoadElement.

Definition at line 69 of file itkFEMLoadEdge.cxx.

References m_Edge, m_Force, and itk::fem::LoadElement::Write().

Member Data Documentation

const int itk::fem::LoadEdge::CLID

static

Class ID for FEM object factory

Reimplemented from itk::fem::LoadElement.

Definition at line 38 of file itkFEMLoadEdge.h.

ElementPointersVectorType itk::fem::LoadElement::el

inherited

Definition at line 54 of file itkFEMLoadElementBase.h.

Referenced by itk::fem::LoadLandmark::AssignToElement(), itk::fem::LoadElement::Read(), itk::fem::LoadLandmark::Read(), and itk::fem::LoadElement::Write().

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 163 of file itkFEMLightObject.h.

Referenced by itk::fem::FEMLightObject::FEMLightObject(), itk::fem::Generate2DRectilinearMesh(), itk::fem::Generate3DRectilinearMesh(), itk::fem::FEMLightObject::Read(), itk::fem::LoadNode::Write(), itk::fem::LoadBC::Write(), and itk::fem::FEMLightObject::Write().

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 56 of file itkFEMLoadEdge.h.

Referenced by Read(), and Write().

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 74 of file itkFEMLoadEdge.h.

Referenced by Read(), and Write().

const std::string itk::fem::FEMLightObject::whitespaces = " \t\n\r"

staticinherited

Const string of all whitespace characters. This string is used by SkipWhiteSpace function.

Definition at line 133 of file itkFEMLightObject.h.

Referenced by itk::fem::FEMLightObject::CreateFromStream(), and itk::fem::MaterialLinearElasticity::Read().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

Member Function Documentation

Member Data Documentation