Generic essential (Dirichlet) boundary conditions. More...

#include <itkFEMLoadBC.h>

Inheritance diagram for itk::fem::LoadBC:

Collaboration diagram for itk::fem::LoadBC:

Public Types
typedef FEMPArray< Self >	ArrayType
typedef Self	Baseclass
typedef const Self *	ConstPointer
typedef Self *	Pointer
typedef LoadBC	Self
typedef Load	Superclass

Public Member Functions
	LoadBC ()
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
int	GN
unsigned int	m_dof
Element::ConstPointer	m_element
vnl_vector< Element::Float >	m_value

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

Detailed Description

Generic essential (Dirichlet) boundary conditions.

Objects of this class specify, which DOFs in a system are fixed.

Definition at line 31 of file itkFEMLoadBC.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::LoadBC::ConstPointer

Const pointer or SmartPointer to an object.

Reimplemented from itk::fem::Load.

Definition at line 33 of file itkFEMLoadBC.h.

typedef Self* itk::fem::LoadBC::Pointer

Pointer or SmartPointer to an object.

Reimplemented from itk::fem::Load.

Definition at line 33 of file itkFEMLoadBC.h.

typedef LoadBC itk::fem::LoadBC::Self

Standard Self typedef.

Reimplemented from itk::fem::Load.

Definition at line 33 of file itkFEMLoadBC.h.

typedef Load itk::fem::LoadBC::Superclass

Standard Superclass typedef.

Reimplemented from itk::fem::Load.

Definition at line 33 of file itkFEMLoadBC.h.

Constructor & Destructor Documentation

itk::fem::LoadBC::LoadBC ( )

inline

Default constructor

Definition at line 58 of file itkFEMLoadBC.h.

Member Function Documentation

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

inlinevirtual

Virtual function to access the class ID

Implements itk::fem::FEMLightObject.

Definition at line 33 of file itkFEMLoadBC.h.

virtual Baseclass::Pointer itk::fem::LoadBC::Clone ( ) const

virtual

Create a new object from the existing one

Implements itk::fem::FEMLightObject.

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::LoadBC::New ( void )

inlinestatic

Object creation in an itk compatible way

Definition at line 33 of file itkFEMLoadBC.h.

Referenced by itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::ApplyLoads().

void itk::fem::LoadBC::Read	(	std::istream &	f,
		void *	info
	)

virtual

Read a LoadBC object from input stream.

Read the LoadBC object from input stream

Convert the info pointer to a usable objects

Reimplemented from itk::fem::FEMLightObject.

Definition at line 29 of file itkFEMLoadBC.cxx.

References itk::fem::FEMPArray< T >::Find(), itk::fem::FEMExceptionObjectNotFound::m_baseClassName, m_dof, m_element, itk::fem::FEMExceptionObjectNotFound::m_GN, m_value, itk::fem::FEMLightObject::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(), itk::fem::LoadEdge::Read(), itk::fem::LoadNode::Read(), itk::fem::LoadElement::Read(), 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::LoadBC::Write ( std::ostream & f ) const

virtual

Write a LoadBC object to the output stream

Write the LoadBC object to the output stream

Reimplemented from itk::fem::FEMLightObject.

Definition at line 73 of file itkFEMLoadBC.cxx.

References itk::fem::FEMLightObject::GN, m_dof, m_element, m_value, and itk::fem::FEMLightObject::Write().

Member Data Documentation

const int itk::fem::LoadBC::CLID

static

Class ID for FEM object factory

Definition at line 33 of file itkFEMLoadBC.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 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(), Write(), and itk::fem::FEMLightObject::Write().

unsigned int itk::fem::LoadBC::m_dof

Local DOF number within the Element object.

Definition at line 45 of file itkFEMLoadBC.h.

Referenced by Read(), and Write().

Element::ConstPointer itk::fem::LoadBC::m_element

Pointer to an element, which holds the DOF that is affected by boundary condition.

Definition at line 40 of file itkFEMLoadBC.h.

Referenced by Read(), and Write().

vnl_vector<Element::Float> itk::fem::LoadBC::m_value

Value which the DOF is being fixed.

Note:: This 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 55 of file itkFEMLoadBC.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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation