Base class for a data structure for holding FEM mesh data of different dimensions. More...

#include <Fem.h>

Inheritance diagram for SurgSim::Physics::Fem< VertexData, Element >:

Public Member Functions
	Fem ()
	Default constructor.

size_t	addElement (std::shared_ptr< Element > element)
	Adds FEM element to mesh of Element template type. More...

size_t	getNumElements () const
	Gets number of FEM elements in the mesh. More...

const std::vector< std::shared_ptr< Element > > &	getElements () const
	Gets entire FEM element vector. More...

std::vector< std::shared_ptr< Element > > &	getElements ()
	Gets entire FEM element vector (non-const) More...

std::shared_ptr< Element >	getElement (size_t id) const
	Retrieve a specific element from the mesh. More...

size_t	addBoundaryCondition (size_t boundaryCondition)
	Add boundary condition to mesh. More...

const std::vector< size_t > &	getBoundaryConditions () const
	Gets entire vector of boundary conditions. More...

std::vector< size_t > &	getBoundaryConditions ()
	Gets entire vector of boundary conditions (non-const) More...

size_t	getBoundaryCondition (size_t id) const
	Retrieves a specific boundary condition. More...

Public Member Functions inherited from SurgSim::DataStructures::Vertices< VertexData >
	Vertices ()
	Constructor.

template<class V >
	Vertices (const Vertices< V > &other)
	Copy constructor when the template data is a different type In this case, no data will be copied. More...

template<class V >
Vertices< VertexData > &	operator= (const Vertices< V > &other)
	Assignment when the template data is a different type In this case, no data will be copied. More...

virtual	~Vertices ()
	Destructor.

void	clear ()
	Clear mesh to return to an empty state (no vertices).

bool	update ()
	Performs any updates that are required when the vertices are modified. More...

size_t	addVertex (const VertexType &vertex)
	Adds a vertex to the mesh. More...

size_t	getNumVertices () const
	Returns the number of vertices in this mesh.

const VertexType &	getVertex (size_t id) const
	Returns the specified vertex.

VertexType &	getVertex (size_t id)
	Returns the specified vertex (non const version).

const std::vector< VertexType > &	getVertices () const
	Returns a vector containing the position of each vertex.

std::vector< VertexType > &	getVertices ()
	Returns a vector containing the position of each vertex (non const version).

void	setVertexPosition (size_t id, const SurgSim::Math::Vector3d &position)
	Sets the position of a vertex. More...

const SurgSim::Math::Vector3d &	getVertexPosition (size_t id) const
	Returns the position of a vertex. More...

void	setVertexPositions (const std::vector< SurgSim::Math::Vector3d > &positions, bool doUpdate=true)
	Sets the position of each vertex. More...

void	transform (const Math::RigidTransform3d &pose)
	Apply a rigid transform to each vertex. More...

bool	operator== (const Vertices &mesh) const
	Compares the mesh with another one (equality) More...

bool	operator!= (const Vertices &mesh) const
	Compares the mesh with another one (inequality) More...

Public Member Functions inherited from SurgSim::Framework::Asset
	Asset ()
	Constructor.

	Asset (const Asset &rhs)
	Copy Constructor.

virtual	~Asset ()
	Destructor.

void	load (const std::string &fileName, const SurgSim::Framework::ApplicationData &data)
	Load a file with given name using 'data' as look up path(s). More...

void	load (const std::string &fileName)
	Overloaded function using SurgSim::Framework::Runtime::getApplicationData() as look up path(s). More...

std::string	getFileName () const
	Return the name of file loaded by this class. More...

virtual std::string	getClassName () const =0
	Support serialization with a classname. More...

Public Member Functions inherited from SurgSim::Framework::Accessible
	Accessible ()
	Default Constructor.

	~Accessible ()
	Destructor.

template<class T >
T	getValue (const std::string &name) const
	Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...

boost::any	getValue (const std::string &name) const
	Retrieves the value with the name by executing the getter if it is found. More...

template<class T >
bool	getValue (const std::string &name, T *value) const
	Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...

void	setValue (const std::string &name, const boost::any &value)
	Sets a value of a property that has setter. More...

bool	isReadable (const std::string &name) const
	Check whether a property is readable. More...

bool	isWriteable (const std::string &name) const
	Check whether a property is writable. More...

void	setGetter (const std::string &name, GetterType func)
	Sets a getter for a given property. More...

void	setSetter (const std::string &name, SetterType func)
	Sets a setter for a given property. More...

void	setAccessors (const std::string &name, GetterType getter, SetterType setter)
	Sets the accessors getter and setter in one function. More...

void	removeAccessors (const std::string &name)
	Removes all the accessors (getter and setter) for a given property. More...

void	forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
	Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...

void	setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
	Sets the functions used to convert data from and to a YAML::Node. More...

void	setDecoder (const std::string &name, DecoderType decoder)
	Sets the functions used to convert data from a YAML::Node. More...

YAML::Node	encode () const
	Encode this Accessible to a YAML::Node. More...

void	decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
	Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...

std::vector< std::string >	getProperties ()

template<>
boost::any	getValue (const std::string &name) const

Protected Member Functions
template<class PlyType , class FemType >
bool	loadFemFile (const std::string &filename)
	Shared loading method for all 3 dimensions. More...

Protected Member Functions inherited from SurgSim::DataStructures::Vertices< VertexData >
virtual void	doClearVertices ()
	Remove all vertices from the mesh.

virtual bool	isEqual (const Vertices &mesh) const
	Internal comparison of meshes of the same type: returns true if equal, false if not equal. More...

Protected Member Functions inherited from SurgSim::Framework::Asset
virtual bool	doLoad (const std::string &filePath)=0
	Derived classes will overwrite this method to do actual loading. More...

Protected Attributes
std::vector< std::shared_ptr< Element > >	m_elements
	Vector of individual elements.

std::vector< size_t >	m_boundaryConditions
	Vector of vertex ids that have boundary conditions.

Additional Inherited Members
Public Types inherited from SurgSim::DataStructures::Vertices< VertexData >
typedef Vertex< VertexData >	VertexType
	Vertex type for convenience.

Public Types inherited from SurgSim::Framework::Accessible
typedef std::function< boost::any(void)>	GetterType

typedef std::function< void(boost::any)>	SetterType

typedef std::function< YAML::Node(void)>	EncoderType

typedef std::function< void(const YAML::Node *)>	DecoderType

Public Types inherited from SurgSim::Framework::FactoryBase< Asset >
typedef ObjectFactory< Asset >	FactoryType

Static Public Member Functions inherited from SurgSim::Framework::FactoryBase< Asset >
static FactoryType &	getFactory ()

Detailed Description

template<class VertexData, class Element>
class SurgSim::Physics::Fem< VertexData, Element >

Base class for a data structure for holding FEM mesh data of different dimensions.

Fem itself should not be used directly itself as it contains no override for doLoad since the implementation is dependent on the dimension of the FEM you are trying to load. Each dimension overrides the doLoad function present in Asset using its own version of an FemPlyReaderDelegate. Each dimension supports loading both linear and corotational models.

Template Parameters

VertexData	Type of extra data stored in each vertex
Element	Type of FEM element the mesh will be storing

See also: TriangleMesh

Member Function Documentation

§ addBoundaryCondition()

template<class VertexData , class Element >

size_t SurgSim::Physics::Fem< VertexData, Element >::addBoundaryCondition ( size_t boundaryCondition )

Add boundary condition to mesh.

Parameters

boundaryCondition A vertex id that has a boundary condition

Returns: The new size of the vector of boundary conditions

§ addElement()

template<class VertexData , class Element>

size_t SurgSim::Physics::Fem< VertexData, Element >::addElement ( std::shared_ptr< Element > element )

Adds FEM element to mesh of Element template type.

Parameters

element A shared pointer of the Element template type

Returns: The new size of the vector of elements

§ getBoundaryCondition()

template<class VertexData , class Element >

size_t SurgSim::Physics::Fem< VertexData, Element >::getBoundaryCondition ( size_t id ) const

Retrieves a specific boundary condition.

Parameters

id	The id of the boundary condition in the vector

Returns: The vertex id which has a boundary condition

§ getBoundaryConditions() [1/2]

template<class VertexData , class Element >

const std::vector< size_t > & SurgSim::Physics::Fem< VertexData, Element >::getBoundaryConditions ( ) const

Gets entire vector of boundary conditions.

Returns: A vector of boundary conditions

§ getBoundaryConditions() [2/2]

template<class VertexData , class Element >

std::vector< size_t > & SurgSim::Physics::Fem< VertexData, Element >::getBoundaryConditions ( )

Gets entire vector of boundary conditions (non-const)

Returns: A vector of boundary conditions

§ getElement()

template<class VertexData , class Element >

std::shared_ptr< Element > SurgSim::Physics::Fem< VertexData, Element >::getElement ( size_t id ) const

Retrieve a specific element from the mesh.

Parameters

id	The id in the element vector

Returns: A shared pointer to the element

§ getElements() [1/2]

template<class VertexData , class Element >

const std::vector< std::shared_ptr< Element > > & SurgSim::Physics::Fem< VertexData, Element >::getElements ( ) const

Gets entire FEM element vector.

Returns: A const vector of all FEM elements stored in the mesh

§ getElements() [2/2]

template<class VertexData , class Element >

std::vector< std::shared_ptr< Element > > & SurgSim::Physics::Fem< VertexData, Element >::getElements ( )

Gets entire FEM element vector (non-const)

Returns: A vector of all FEM elements stored in the mesh

§ getNumElements()

template<class VertexData , class Element >

size_t SurgSim::Physics::Fem< VertexData, Element >::getNumElements ( ) const

Gets number of FEM elements in the mesh.

Returns: The number of FEM elements stored

§ loadFemFile()

template<class VertexData , class Element >

template<class PlyType , class FemType >

bool SurgSim::Physics::Fem< VertexData, Element >::loadFemFile ( const std::string & filename )

protected

Shared loading method for all 3 dimensions.

Note: Assign template class to the proper dimension PlyReaderDelegate

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

SurgSim/Physics/Fem.h
SurgSim/Physics/Fem-inl.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class VertexData, class Element> class SurgSim::Physics::Fem< VertexData, Element >

Member Function Documentation

§ addBoundaryCondition()

§ addElement()

§ getBoundaryCondition()

§ getBoundaryConditions() [1/2]

§ getBoundaryConditions() [2/2]

§ getElement()

§ getElements() [1/2]

§ getElements() [2/2]

§ getNumElements()

§ loadFemFile()

template<class VertexData, class Element>
class SurgSim::Physics::Fem< VertexData, Element >