itk::fem::LoadBCMFC Class Reference

Generic linear multi freedom displacement constraint in global coordinate system. More...

#include <itkFEMLoadBCMFC.h>

Inheritance diagram for itk::fem::LoadBCMFC:

Collaboration diagram for itk::fem::LoadBCMFC:

List of all members.

Classes

class MFCTerm

Class that holds information about one term in MFC constraint equation. More...

Public Types

typedef FEMPArray< Self > ArrayType

typedef Self Baseclass

typedef const Self * ConstPointer

typedef std::vector< MFCTerm > LhsType

typedef Self * Pointer

typedef LoadBCMFC Self

typedef Load Superclass

Public Member Functions

virtual int ClassID () const

virtual Baseclass::Pointer Clone () const

LoadBCMFC (Element::ConstPointer element, int dof, vnl_vector< Element::Float > val)

LoadBCMFC ()

virtual void Read (std::istream &f, void *info)

virtual void Write (std::ostream &f) const

virtual Solution::ConstPointer GetSolution ()

virtual void SetSolution (Solution::ConstPointer)

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

int GN

int Index

LhsType lhs

vnl_vector< Element::Float > rhs

Static Public Attributes

static const int CLID

static const std::string whitespaces

Friends

class Solver

Detailed Description

Generic linear multi freedom displacement constraint in global coordinate system.

These constraints are implemented using the Lagrange multiplier method. We treat displacement constraints (or essential boundary conditions, which are exactly the same but with less functionality) as a special kind of load on the system.

How to store data in a LoadBCMFC object... Suppose you want to impose the following constraint to the system:

0.5*u1x + 2.1*u5y = 10.0

u1x is the first DOF in the element with global number 1, and u5y is the second DOF in an element with GN=5.

... then use the following lines of code itk::LoadBCMFC m; m.lhs.push_back( LoadBCMFC::MFCTerm( elements.Find(1), 0, 0.5 ) ); m.lhs.push_back( LoadBCMFC::MFCTerm( elements.Find(5), 1, 2.1 ) ); m.rhs=10.0;

Definition at line 52 of file itkFEMLoadBCMFC.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 64 of file itkFEMLightObject.h.

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

Const pointer or SmartPointer to an object.

Reimplemented from itk::fem::Load.

Definition at line 54 of file itkFEMLoadBCMFC.h.

typedef std::vector<MFCTerm> itk::fem::LoadBCMFC::LhsType

Left hand side of the MFC constraint equation

Definition at line 91 of file itkFEMLoadBCMFC.h.

typedef Self* itk::fem::LoadBCMFC::Pointer

Pointer or SmartPointer to an object.

Reimplemented from itk::fem::Load.

Definition at line 54 of file itkFEMLoadBCMFC.h.

typedef LoadBCMFC itk::fem::LoadBCMFC::Self

Standard Self typedef.

Reimplemented from itk::fem::Load.

Definition at line 54 of file itkFEMLoadBCMFC.h.

typedef Load itk::fem::LoadBCMFC::Superclass

Standard Superclass typedef.

Reimplemented from itk::fem::Load.

Definition at line 54 of file itkFEMLoadBCMFC.h.

Constructor & Destructor Documentation

itk::fem::LoadBCMFC::LoadBCMFC ( ) [inline]

Default constructor

Definition at line 103 of file itkFEMLoadBCMFC.h.

itk::fem::LoadBCMFC::LoadBCMFC	(	Element::ConstPointer	element,
		int	dof,
		vnl_vector< Element::Float >	val
	)

With this constructor, we can easy fix the global displacement dof given by node to a value val.

Parameters:

	element	Pointer to an element, which holds a displacements that needs to be fixed.
	dof	Local DOF number in an element.
	val	The fixed value of a DOF.

Member Function Documentation

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

Virtual function to access the class ID

Implements itk::fem::FEMLightObject.

Definition at line 54 of file itkFEMLoadBCMFC.h.

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

Create a new object from the existing one

Implements itk::fem::FEMLightObject.

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]

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 57 of file itkFEMLoadBase.h.

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

Object creation in an itk compatible way

Definition at line 54 of file itkFEMLoadBCMFC.h.

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

read a LoadBCMFC object from input stream.

Reimplemented from itk::fem::FEMLightObject.

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

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.

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::LoadBCMFC::Write ( std::ostream & f ) const [virtual]

write a LoadBCMFC object to the output stream.

Reimplemented from itk::fem::FEMLightObject.

Friends And Related Function Documentation

friend class Solver [friend]

Definition at line 125 of file itkFEMLoadBCMFC.h.

Member Data Documentation

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

Class ID for FEM object factory

Definition at line 54 of file itkFEMLoadBCMFC.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 165 of file itkFEMLightObject.h.

Referenced by itk::fem::FEMLightObject::FEMLightObject().

int itk::fem::LoadBCMFC::Index

used internally by the Solver class

Definition at line 124 of file itkFEMLoadBCMFC.h.

LhsType itk::fem::LoadBCMFC::lhs

Definition at line 92 of file itkFEMLoadBCMFC.h.

vnl_vector<Element::Float> itk::fem::LoadBCMFC::rhs

Right hand side of the linear equation that defines the constraints. It is a vector so that implementation of BC on isotropic elements is easy. Which value is applied to the master force vector is defined by optional dim parameter (defaults to 0) in AssembleF function in solver.

Definition at line 100 of file itkFEMLoadBCMFC.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 135 of file itkFEMLightObject.h.

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

itkFEMLoadBCMFC.h


Classes
class	MFCTerm
	Class that holds information about one term in MFC constraint equation. More...
Public Types
typedef FEMPArray< Self >	ArrayType
typedef Self	Baseclass
typedef const Self *	ConstPointer
typedef std::vector< MFCTerm >	LhsType
typedef Self *	Pointer
typedef LoadBCMFC	Self
typedef Load	Superclass
Public Member Functions
virtual int	ClassID () const
virtual Baseclass::Pointer	Clone () const
	LoadBCMFC (Element::ConstPointer element, int dof, vnl_vector< Element::Float > val)
	LoadBCMFC ()
virtual void	Read (std::istream &f, void *info)
virtual void	Write (std::ostream &f) const

virtual Solution::ConstPointer	GetSolution ()
virtual void	SetSolution (Solution::ConstPointer)
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
int	GN
int	Index
LhsType	lhs
vnl_vector< Element::Float >	rhs
Static Public Attributes
static const int	CLID
static const std::string	whitespaces
Friends
class	Solver