Entity Class Reference

Low storage struct to uniquely identify one element. More...

#include <Entities.hpp>

Public Member Functions
	Entity ()
	Entity (const Entity &other)
	Entity (const Entities &entities, const Uint index=0)
	Entity (const Handle< Entities > &entities, const Uint index=0)
ElementType &	element_type () const
	return the elementType More...
Uint	comp_idx () const
Uint	glb_idx () const
Uint	rank () const
bool	is_ghost () const
RealMatrix	get_coordinates () const
void	put_coordinates (RealMatrix &coordinates) const
void	allocate_coordinates (RealMatrix &coordinates) const
common::TableConstRow< Uint >::type	get_nodes () const
bool	operator== (const Entity &other) const
bool	operator!= (const Entity &other) const
bool	operator< (const Entity &other) const

Static Public Member Functions
static std::string	type_name ()

Public Attributes
Entities *	comp
Uint	idx

Friends
std::ostream &	operator<< (std::ostream &os, const Entity &entity)

Detailed Description

Low storage struct to uniquely identify one element.

Several access-functions are provided for convenience

Definition at line 141 of file Entities.hpp.

Constructor & Destructor Documentation

Entity ( )

inline

Definition at line 144 of file Entities.hpp.

Entity ( const Entity &  other )

inline

Definition at line 145 of file Entities.hpp.

Entity ( const Entities &  entities, const Uint  index = 0  )

inline

Definition at line 147 of file Entities.hpp.

Entity ( const Handle< Entities > &  entities, const Uint  index = 0  )

inline

Definition at line 153 of file Entities.hpp.

Member Function Documentation

void allocate_coordinates

(

RealMatrix &

coordinates

)

const

Definition at line 215 of file Entities.cpp.

Uint comp_idx

(

)

const

Definition at line 209 of file Entities.cpp.

ElementType & element_type

(

)

const

return the elementType

Definition at line 208 of file Entities.cpp.

RealMatrix get_coordinates

(

)

const

Definition at line 213 of file Entities.cpp.

Connectivity::ConstRow get_nodes

(

)

const

Definition at line 216 of file Entities.cpp.

Uint glb_idx

(

)

const

Definition at line 210 of file Entities.cpp.

bool is_ghost

(

)

const

Definition at line 212 of file Entities.cpp.

bool operator!= ( const Entity &  other ) const

inline

Definition at line 183 of file Entities.hpp.

bool operator< ( const Entity &  other ) const

inline

Definition at line 184 of file Entities.hpp.

bool operator== ( const Entity &  other ) const

inline

Definition at line 182 of file Entities.hpp.

void put_coordinates

(

RealMatrix &

coordinates

)

const

Definition at line 214 of file Entities.cpp.

Uint rank

(

)

const

Definition at line 211 of file Entities.cpp.

static std::string type_name ( )

inlinestatic

Definition at line 164 of file Entities.hpp.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const Entity &  entity  )

friend

Definition at line 217 of file Entities.cpp.

Member Data Documentation

Entities* comp

Definition at line 160 of file Entities.hpp.

Uint idx

Definition at line 161 of file Entities.hpp.

---

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

• cf3/mesh/Entities.hpp
• cf3/mesh/Entities.cpp