itk::fem::LoadBC Class Reference

#include <itkFEMLoadBC.h>

Inheritance diagram for itk::fem::LoadBC:

Collaboration diagram for itk::fem::LoadBC:

Detailed Description

Generic essential (Dirichlet) boundary conditions.

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

Definition at line 35 of file itkFEMLoadBC.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LoadBC	Self
typedef Load	Superclass
Public Types inherited from itk::fem::Load
typedef FEMPArray< Self >	ArrayType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Load	Self
typedef FEMLightObject	Superclass
Public Types inherited from itk::fem::FEMLightObject
typedef Self	Baseclass
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef FEMLightObject	Self
typedef itk::LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const override
int	GetDegreeOfFreedom () const
virtual const char *	GetNameOfClass () const
vnl_vector< Element::Float >	GetValue () const
	LoadBC ()
void	SetDegreeOfFreedom (int dof)
void	SetValue (const vnl_vector< Element::Float > val)
Public Member Functions inherited from itk::fem::Load
const Element *	GetElement () const
virtual Solution::ConstPointer	GetSolution ()
void	SetElement (const Element *el)
virtual void	SetSolution (Solution::ConstPointer)
Public Member Functions inherited from itk::fem::FEMLightObject
int	GetGlobalNumber () const
void	SetGlobalNumber (int)
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
Protected Member Functions inherited from itk::fem::FEMLightObject
	FEMLightObject ()
	FEMLightObject (const FEMLightObject &o)
virtual	~FEMLightObject ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
unsigned int	m_DegreeOfFreedom
vnl_vector< Element::Float >	m_Value
Protected Attributes inherited from itk::fem::Load
Element::ConstPointer	m_Element
Protected Attributes inherited from itk::fem::FEMLightObject
int	m_GlobalNumber
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer<const Self> itk::fem::LoadBC::ConstPointer

Definition at line 43 of file itkFEMLoadBC.h.

typedef SmartPointer<Self> itk::fem::LoadBC::Pointer

Definition at line 42 of file itkFEMLoadBC.h.

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

Standard class typedefs.

Definition at line 40 of file itkFEMLoadBC.h.

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

Definition at line 41 of file itkFEMLoadBC.h.

Constructor & Destructor Documentation

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

inline

Default constructor

Definition at line 56 of file itkFEMLoadBC.h.

Member Function Documentation

virtual::itk::LightObject::Pointer itk::fem::LoadBC::CreateAnother ( void  ) const

overridevirtual

CreateAnother method will clone the existing instance of this type, including its internal member variables.

Reimplemented from itk::LightObject.

int itk::fem::LoadBC::GetDegreeOfFreedom

(

)

const

Get the number of degrees of freedom

virtual const char* itk::fem::LoadBC::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::fem::Load.

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

(

)

const

Get the boundary condition as vector representation

static Pointer itk::fem::LoadBC::New ( )

static

Method for creation through the object factory.

virtual void itk::fem::LoadBC::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::fem::Load.

void itk::fem::LoadBC::SetDegreeOfFreedom

(

int

dof

)

Set the number of degrees of freedom

void itk::fem::LoadBC::SetValue

(

const vnl_vector< Element::Float >

val

)

Set the boundary condition using vector representation

Member Data Documentation

unsigned int itk::fem::LoadBC::m_DegreeOfFreedom

protected

Local DOF number within the Element object.

Definition at line 78 of file itkFEMLoadBC.h.

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

protected

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 88 of file itkFEMLoadBC.h.

---

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

• itkFEMLoadBC.h