itk::fem::LoadElement Class Reference
Virtual element load base class. More...
#include <itkFEMLoadElementBase.h>
Public Types | |
| typedef FEMPArray< Self > | ArrayType |
| typedef Self | Baseclass |
| typedef const Self * | ConstPointer |
| typedef std::vector < Element::ConstPointer > | ElementPointersVectorType |
| typedef Element::Float | Float |
| typedef Self * | Pointer |
| typedef LoadElement | Self |
| typedef Load | Superclass |
Public Member Functions | |
| virtual int | ClassID () const |
| virtual Baseclass::Pointer | Clone () const |
| LoadElement () | |
| virtual void | Read (std::istream &f, void *info) |
| 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 |
Static Public Attributes | |
| static const int | CLID |
| static const std::string | whitespaces |
Detailed Description
Virtual element load base class.
This load class defines an external load that acts on elements in a system. The vector with pointers to elements defines, on which elements the load acts. The derived load classes should provide members, that allow the Element's class Fe() member function to uniquely transform the load into nodal loads. No special requirements are enforced on those members.
Ultimately, when assembling the right hand side of the master equation (master force vector) the Element's Fe() member funtion is called with the pointer to the LoadElement class that is prescribed on that element. Fe() function shuld dynamically cast this pointer to specific load class, which it can handle and return the element's force vector.
Definition at line 41 of file itkFEMLoadElementBase.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::LoadElement::ConstPointer |
Const pointer or SmartPointer to an object.
Reimplemented from itk::fem::Load.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadEdge, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadPoint, and itk::fem::LoadTest< TClass >.
Definition at line 43 of file itkFEMLoadElementBase.h.
| typedef std::vector<Element::ConstPointer> itk::fem::LoadElement::ElementPointersVectorType |
Type of array of pointers to element objects
Definition at line 54 of file itkFEMLoadElementBase.h.
Float type used in Element and derived classes
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, and itk::fem::ImageMetricLoad< TMoving, TFixed >.
Definition at line 49 of file itkFEMLoadElementBase.h.
| typedef Self* itk::fem::LoadElement::Pointer |
Pointer or SmartPointer to an object.
Reimplemented from itk::fem::Load.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadEdge, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadPoint, and itk::fem::LoadTest< TClass >.
Definition at line 43 of file itkFEMLoadElementBase.h.
Standard Self typedef.
Reimplemented from itk::fem::Load.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadEdge, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadPoint, and itk::fem::LoadTest< TClass >.
Definition at line 43 of file itkFEMLoadElementBase.h.
Standard Superclass typedef.
Reimplemented from itk::fem::Load.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadEdge, itk::fem::LoadGrav, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadPoint, and itk::fem::LoadTest< TClass >.
Definition at line 43 of file itkFEMLoadElementBase.h.
Constructor & Destructor Documentation
| itk::fem::LoadElement::LoadElement | ( | ) | [inline] |
Definition at line 62 of file itkFEMLoadElementBase.h.
Member Function Documentation
| virtual int itk::fem::LoadElement::ClassID | ( | ) | const [inline, virtual] |
Virtual function to access the class ID
Implements itk::fem::FEMLightObject.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadPoint, and itk::fem::LoadTest< TClass >.
Definition at line 43 of file itkFEMLoadElementBase.h.
| virtual Baseclass::Pointer itk::fem::LoadElement::Clone | ( | ) | const [virtual] |
Create a new object from the existing one
Implements itk::fem::FEMLightObject.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadPoint, and itk::fem::LoadTest< TClass >.
| 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::LoadElement::New | ( | void | ) | [inline, static] |
Object creation in an itk compatible way
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadPoint, and itk::fem::LoadTest< TClass >.
Definition at line 43 of file itkFEMLoadElementBase.h.
| virtual void itk::fem::LoadElement::Read | ( | std::istream & | f, | |
| void * | info | |||
| ) | [virtual] |
pointers to element objects on which the load acts
Reimplemented from itk::fem::FEMLightObject.
Reimplemented in itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, and itk::fem::LoadTest< TClass >.
Referenced by itk::fem::LoadTest< TClass >::Read().
| 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.
| void itk::fem::LoadElement::Write | ( | std::ostream & | f | ) | const [virtual] |
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 from itk::fem::FEMLightObject.
Reimplemented in itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, and itk::fem::LoadTest< TClass >.
Referenced by itk::fem::LoadTest< TClass >::Write().
Member Data Documentation
const int itk::fem::LoadElement::CLID [static] |
Class ID for FEM object factory
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, itk::fem::LoadPoint, and itk::fem::LoadTest< TClass >.
Definition at line 43 of file itkFEMLoadElementBase.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().
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:
