itk::fem::Load Class Reference

#include <itkFEMLoadBase.h>

Inheritance diagram for itk::fem::Load:

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

[legend]List of all members.

Detailed Description

General abstract load base class.

All other load classes that can be used in a FEM system are defined by deriving this one. The load class defines an external load that acts on the system. For each specific subtype of load, a separate load abstract class should be derived. For example we have LoadElement, which defines the base for all loads that act on a specific element in a system.

Definition at line 39 of file itkFEMLoadBase.h.

Public Types

typedef FEMPArray< Self > ArrayType

typedef Self Baseclass

typedef const Self * ConstPointer

typedef Self * Pointer

typedef Load Self

typedef FEMLightObject Superclass

Public Member Functions

virtual int ClassID () const =0

virtual Baseclass::Pointer Clone () const =0

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

*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 std::string whitespaces

Member Typedef Documentation

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

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::Load::ConstPointer

Const pointer or SmartPointer to an object.
Reimplemented from itk::fem::FEMLightObject.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadTest< TClass >, and itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >.
Definition at line 41 of file itkFEMLoadBase.h.

typedef Self* itk::fem::Load::Pointer

Pointer or SmartPointer to an object.
Reimplemented from itk::fem::FEMLightObject.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadTest< TClass >, and itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >.
Definition at line 41 of file itkFEMLoadBase.h.

typedef Load itk::fem::Load::Self

Standard Self typedef.
Reimplemented from itk::fem::FEMLightObject.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadTest< TClass >, and itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >.
Definition at line 41 of file itkFEMLoadBase.h.

typedef FEMLightObject itk::fem::Load::Superclass

Standard Superclass typedef.
Reimplemented from itk::fem::FEMLightObject.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadPoint, itk::fem::LoadTest< TClass >, and itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >.
Definition at line 41 of file itkFEMLoadBase.h.

Member Function Documentation

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]

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.

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

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::FEMLightObject::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 in itk::fem::Element2DC1Beam, itk::fem::Element::Node, itk::fem::LoadBC, itk::fem::LoadBCMFC, itk::fem::LoadEdge, itk::fem::LoadElement, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadNode, itk::fem::LoadTest< TClass >, itk::fem::MaterialLinearElasticity, itk::fem::Element1DStress< Element2DC0LinearLine >, itk::fem::Element2DMembrane< Element2DC0LinearQuadrilateral >, itk::fem::Element2DMembrane< Element2DC0LinearTriangular >, itk::fem::Element2DStrain< Element2DC0QuadraticTriangular >, itk::fem::Element2DStrain< Element2DC0LinearQuadrilateral >, itk::fem::Element2DStrain< Element2DC0LinearTriangular >, itk::fem::Element2DStress< Element2DC0QuadraticTriangular >, itk::fem::Element2DStress< Element2DC0LinearQuadrilateral >, itk::fem::Element2DStress< Element2DC0LinearTriangular >, itk::fem::Element3DMembrane< Element3DC0LinearHexahedron >, itk::fem::Element3DMembrane< Element3DC0LinearTetrahedron >, itk::fem::Element3DStrain< Element3DC0LinearHexahedron >, itk::fem::Element3DStrain< Element3DC0LinearTetrahedron >, itk::fem::ElementStd< 3, 2 >, itk::fem::ElementStd< 2, 2 >, itk::fem::ElementStd< 8, 3 >, itk::fem::ElementStd< 6, 2 >, itk::fem::ElementStd< 4, 3 >, and itk::fem::ElementStd< 4, 2 >.

Member Data Documentation

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().

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:

itkFEMLoadBase.h

Generated at Sun Jul 9 23:36:01 2006 for ITK by


Public Types
typedef FEMPArray< Self >	ArrayType
typedef Self	Baseclass
typedef const Self *	ConstPointer
typedef Self *	Pointer
typedef Load	Self
typedef FEMLightObject	Superclass
Public Member Functions
virtual int	ClassID () const =0
virtual Baseclass::Pointer	Clone () const =0
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 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
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 std::string	whitespaces