itk::fem::LoadNode Class Reference
This load is applied on a specific point within the system. More...
#include <itkFEMLoadNode.h>
Public Types | |
| typedef FEMPArray< Self > | ArrayType |
| typedef Self | Baseclass |
| typedef const Self * | ConstPointer |
| typedef Node::Float | Float |
| typedef Self * | Pointer |
| typedef LoadNode | Self |
| typedef Load | Superclass |
Public Member Functions | |
| virtual int | ClassID () const |
| virtual Baseclass::Pointer | Clone () const |
| LoadNode (Element::ConstPointer element_, unsigned int pt_, vnl_vector< Float > F_) | |
| LoadNode () | |
| 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 | |
| vnl_vector< Float > | F |
| int | GN |
| Element::ConstPointer | m_element |
| unsigned int | m_pt |
Static Public Attributes | |
| static const int | CLID |
| static const std::string | whitespaces |
Detailed Description
This load is applied on a specific point within the system.
The point is defined as a point within an element object.
You must provide a pointer to an element object and a number of point on which on which the load acts. Force vector F should have element->GetNumberOfDegreesOfFreedomPerNode() dimensions.
Definition at line 37 of file itkFEMLoadNode.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::LoadNode::ConstPointer |
Const pointer or SmartPointer to an object.
Reimplemented from itk::fem::Load.
Definition at line 38 of file itkFEMLoadNode.h.
| typedef Node::Float itk::fem::LoadNode::Float |
Definition at line 41 of file itkFEMLoadNode.h.
| typedef Self* itk::fem::LoadNode::Pointer |
Pointer or SmartPointer to an object.
Reimplemented from itk::fem::Load.
Definition at line 38 of file itkFEMLoadNode.h.
| typedef LoadNode itk::fem::LoadNode::Self |
Standard Self typedef.
Reimplemented from itk::fem::Load.
Definition at line 38 of file itkFEMLoadNode.h.
| typedef Load itk::fem::LoadNode::Superclass |
Standard Superclass typedef.
Reimplemented from itk::fem::Load.
Definition at line 38 of file itkFEMLoadNode.h.
Constructor & Destructor Documentation
| itk::fem::LoadNode::LoadNode | ( | ) | [inline] |
Definition at line 70 of file itkFEMLoadNode.h.
| itk::fem::LoadNode::LoadNode | ( | Element::ConstPointer | element_, | |
| unsigned int | pt_, | |||
| vnl_vector< Float > | F_ | |||
| ) | [inline] |
Definition at line 71 of file itkFEMLoadNode.h.
Member Function Documentation
| virtual int itk::fem::LoadNode::ClassID | ( | ) | const [inline, virtual] |
Virtual function to access the class ID
Implements itk::fem::FEMLightObject.
Definition at line 38 of file itkFEMLoadNode.h.
| virtual Baseclass::Pointer itk::fem::LoadNode::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::LoadNode::New | ( | void | ) | [inline, static] |
Object creation in an itk compatible way
Definition at line 38 of file itkFEMLoadNode.h.
| virtual void itk::fem::LoadNode::Read | ( | std::istream & | f, | |
| void * | info | |||
| ) | [virtual] |
Read a LoadNode 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::LoadNode::Write | ( | std::ostream & | f | ) | const [virtual] |
Write a Load object to the output stream
Reimplemented from itk::fem::FEMLightObject.
Member Data Documentation
const int itk::fem::LoadNode::CLID [static] |
Class ID for FEM object factory
Definition at line 38 of file itkFEMLoadNode.h.
Force applied on the node. Dimension of F should equal element->GetNumberOfDegreesOfFreedomPerNode().
Definition at line 68 of file itkFEMLoadNode.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().
Pointer to an element in a system that contains the DOF on which the external force is applied.
Definition at line 57 of file itkFEMLoadNode.h.
| unsigned int itk::fem::LoadNode::m_pt |
Point within the element on which the force acts.
Definition at line 62 of file itkFEMLoadNode.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:
