SOFA API  8748a421
Open source framework for multi-physics simuation
sofa::geometry Namespace Reference

Namespaces

 proximity
 

Classes

struct  ElementInfo< sofa::core::topology::Topology::Point >
 
struct  Edge
 
struct  ElementInfo
 
struct  Hexahedron
 
struct  CleanupCheck
 
struct  Point
 
struct  Prism
 
struct  Pyramid
 
struct  Quad
 
struct  QuadraticEdge
 
struct  QuadraticTriangle
 
struct  QuadraticQuad
 
struct  QuadraticTetrahedron
 
struct  QuadraticHexahedron
 
struct  QuadraticPrism
 
struct  QuadraticPyramid
 
struct  Tetrahedron
 
struct  Triangle
 

Typedefs

using Prism = Prism
 

Enumerations

enum class  ElementType : sofa::Size {
  UNKNOWN , POINT , EDGE , TRIANGLE ,
  QUAD , TETRAHEDRON , HEXAHEDRON , PRISM ,
  PYRAMID , QUADRATIC_EDGE , QUADRATIC_TRIANGLE , QUADRATIC_QUAD ,
  QUADRATIC_TETRAHEDRON , QUADRATIC_HEXAHEDRON , QUADRATIC_PRISM , QUADRATIC_PYRAMID ,
  SIZE
}
 The enumeration used to give unique identifiers to Topological objects. More...
 

Functions

constexpr const charelementTypeToString (ElementType type)
 
SOFA_GEOMETRY_API void init ()
 Initialize the Sofa.Geometry library. More...
 
SOFA_GEOMETRY_API bool isInitialized ()
 Return true if and only if the Sofa.Geometry library has been initialized. More...
 
SOFA_GEOMETRY_API void cleanup ()
 Clean up the resources used by the Sofa.Geometry library. More...
 
SOFA_GEOMETRY_API bool isCleanedUp ()
 Return true if and only if the Sofa.Geometry library has been cleaned up. More...
 
SOFA_GEOMETRY_API void printUninitializedLibraryWarning (const std::string &library, const std::string &initFunction)
 Print a warning about a library not being initialized (meant for internal use). More...
 
SOFA_GEOMETRY_API void printLibraryNotCleanedUpWarning (const std::string &library, const std::string &cleanupFunction)
 Print a warning about a library not being cleaned up (meant for internal use). More...
 

Variables

template struct SOFA_GEOMETRY_API ElementInfo< Edge >
 
template struct SOFA_GEOMETRY_API ElementInfo< Hexahedron >
 
template struct SOFA_GEOMETRY_API ElementInfo< Prism >
 
template struct SOFA_GEOMETRY_API ElementInfo< Point >
 
template struct SOFA_GEOMETRY_API ElementInfo< Pyramid >
 
template struct SOFA_GEOMETRY_API ElementInfo< Quad >
 
template struct SOFA_GEOMETRY_API ElementInfo< Tetrahedron >
 
template struct SOFA_GEOMETRY_API ElementInfo< Triangle >
 
constexpr sofa::Size NumberOfElementType = static_cast<sofa::Size>(sofa::geometry::ElementType::SIZE)
 

Typedef Documentation

◆ Prism

using sofa::geometry::Prism = typedef Prism

Enumeration Type Documentation

◆ ElementType

enum sofa::geometry::ElementType : sofa::Size
strong

The enumeration used to give unique identifiers to Topological objects.

Enumerator
UNKNOWN 
POINT 
EDGE 
TRIANGLE 
QUAD 
TETRAHEDRON 
HEXAHEDRON 
PRISM 
PYRAMID 
QUADRATIC_EDGE 
QUADRATIC_TRIANGLE 
QUADRATIC_QUAD 
QUADRATIC_TETRAHEDRON 
QUADRATIC_HEXAHEDRON 
QUADRATIC_PRISM 
QUADRATIC_PYRAMID 
SIZE 

Function Documentation

◆ cleanup()

SOFA_GEOMETRY_API void sofa::geometry::cleanup ( )

Clean up the resources used by the Sofa.Geometry library.

◆ elementTypeToString()

constexpr const char* sofa::geometry::elementTypeToString ( ElementType  type)
constexpr

◆ init()

SOFA_GEOMETRY_API void sofa::geometry::init ( )

Initialize the Sofa.Geometry library.

◆ isCleanedUp()

SOFA_GEOMETRY_API bool sofa::geometry::isCleanedUp ( )

Return true if and only if the Sofa.Geometry library has been cleaned up.

◆ isInitialized()

SOFA_GEOMETRY_API bool sofa::geometry::isInitialized ( )

Return true if and only if the Sofa.Geometry library has been initialized.

◆ printLibraryNotCleanedUpWarning()

SOFA_GEOMETRY_API void sofa::geometry::printLibraryNotCleanedUpWarning ( const std::string &  library,
const std::string &  cleanupFunction 
)

Print a warning about a library not being cleaned up (meant for internal use).

◆ printUninitializedLibraryWarning()

SOFA_GEOMETRY_API void sofa::geometry::printUninitializedLibraryWarning ( const std::string &  library,
const std::string &  initFunction 
)

Print a warning about a library not being initialized (meant for internal use).

Variable Documentation

◆ ElementInfo< Edge >

template struct SOFA_GEOMETRY_API sofa::geometry::ElementInfo< Edge >

◆ ElementInfo< Hexahedron >

template struct SOFA_GEOMETRY_API sofa::geometry::ElementInfo< Hexahedron >

◆ ElementInfo< Point >

template struct SOFA_GEOMETRY_API sofa::geometry::ElementInfo< Point >

◆ ElementInfo< Prism >

template struct SOFA_GEOMETRY_API sofa::geometry::ElementInfo< Prism >

◆ ElementInfo< Pyramid >

template struct SOFA_GEOMETRY_API sofa::geometry::ElementInfo< Pyramid >

◆ ElementInfo< Quad >

template struct SOFA_GEOMETRY_API sofa::geometry::ElementInfo< Quad >

◆ ElementInfo< Tetrahedron >

template struct SOFA_GEOMETRY_API sofa::geometry::ElementInfo< Tetrahedron >

◆ ElementInfo< Triangle >

template struct SOFA_GEOMETRY_API sofa::geometry::ElementInfo< Triangle >

◆ NumberOfElementType

constexpr sofa::Size sofa::geometry::NumberOfElementType = static_cast<sofa::Size>(sofa::geometry::ElementType::SIZE)
constexpr