An interface for elements of type FACE. More...

#include <inmost_mesh.h>

Inheritance diagram for INMOST::Face:

Collaboration diagram for INMOST::Face:

Public Member Functions
	Face ()

	Face (const Face &other)

	Face (Mesh *m, HandleType h)

	Face (Mesh m, HandleType h)

Face &	operator= (Face const &other)

Face *	operator-> ()

const Face *	operator-> () const

Face &	self ()

const Face &	self () const

ElementArray< Node >	getNodes () const

ElementArray< Edge >	getEdges () const

ElementArray< Cell >	getCells () const

ElementArray< Node >	getNodes (MarkerType mask, bool invert_mask=false) const

ElementArray< Edge >	getEdges (MarkerType mask, bool invert_mask=false) const

ElementArray< Cell >	getCells (MarkerType mask, bool invert_mask=false) const

Node	getBeg () const

Node	getEnd () const

Cell	BackCell () const
	Retrieve the cell for which the normal points outwards. More...

Cell	FrontCell () const
	Retrieve the cell for which the normal points inwards. More...

bool	FaceOrientedOutside (Cell c) const

void	ReorderEdges () const

bool	CheckEdgeOrder () const

bool	FixEdgeOrder () const

void	SwapCells ()

Storage::real	Area () const

void	Normal (real *nrm) const

void	UnitNormal (real *nrm) const

void	OrientedNormal (Cell c, real *nrm) const

void	OrientedUnitNormal (Cell c, real *nrm) const

bool	FixNormalOrientation () const

bool	CheckNormalOrientation () const

bool	Closure () const

Public Member Functions inherited from INMOST::Element
	Element ()

	Element (Mesh *m, HandleType h)

	Element (Mesh m, HandleType h)

	Element (const Element &other)

Element &	operator= (Element const &other)

Element *	operator-> ()

const Element *	operator-> () const

Element &	self ()

const Element &	self () const

virtual	~Element ()

virtual enumerator	nbAdjElements (ElementType etype) const

virtual ElementArray< Element >	getAdjElements (ElementType etype) const

virtual enumerator	nbAdjElements (ElementType etype, MarkerType mask, bool invert_mask=false) const

virtual ElementArray< Element >	getAdjElements (ElementType etype, MarkerType mask, bool invert_mask=false) const

ElementArray< Element >	BridgeAdjacencies (ElementType Bridge, ElementType Dest, MarkerType mask=0, bool invert_mask=false) const

ElementArray< Node >	BridgeAdjacencies2Node (ElementType Bridge, MarkerType mask=0, bool invert_mask=false) const

ElementArray< Edge >	BridgeAdjacencies2Edge (ElementType Bridge, MarkerType mask=0, bool invert_mask=false) const

ElementArray< Face >	BridgeAdjacencies2Face (ElementType Bridge, MarkerType mask=0, bool invert_mask=false) const

ElementArray< Cell >	BridgeAdjacencies2Cell (ElementType Bridge, MarkerType mask=0, bool invert_mask=false) const

virtual ElementArray< Face >	getFaces () const

virtual ElementArray< Face >	getFaces (MarkerType mask, bool invert_mask=false) const

GeometricType	GetGeometricType () const

unsigned int	GetElementDimension () const

Status	GetStatus () const

void	SetStatus (Status status) const

Storage::integer &	GlobalID () const

bool	CheckElementConnectivity () const

void	PrintElementConnectivity () const

void	CastRay (real pos, real dir, dynarray< std::pair< Element, real >, 16 > &hits) const

void	ComputeGeometricType () const

void	Centroid (real *cnt) const

void	Barycenter (real *cnt) const

Storage::real	Mean (real(func)(real x, real t), real time) const

bool	Boundary () const

bool	Planarity () const

bool	Hide () const

bool	Show () const

bool	Delete ()

bool	Hidden () const

bool	New () const

void	Disconnect (bool delete_upper_adjacent) const

void	Disconnect (const HandleType *adjacent, INMOST_DATA_ENUM_TYPE num) const

void	Connect (const HandleType *adjacent, INMOST_DATA_ENUM_TYPE num) const
	Connects lower adjacencies to current element. Geometric data and cell nodes are updated automatically. More...

void	UpdateGeometricData () const
	Update geometric data for element, calls RecomputeGeometricData from Mesh. More...

Public Member Functions inherited from INMOST::Storage
	Storage (const Storage &other)

	Storage (Mesh *mesh, HandleType handle)

	Storage (Mesh mesh, HandleType handle)
	This constructor allows for remote handle modification. More...

Storage &	operator= (Storage const &other)

__INLINE bool	operator< (const Storage &other) const
	Inline functions for class Storage //. More...

__INLINE bool	operator> (const Storage &other) const

__INLINE bool	operator<= (const Storage &other) const

__INLINE bool	operator>= (const Storage &other) const

__INLINE bool	operator== (const Storage &other) const

__INLINE bool	operator!= (const Storage &other) const

__INLINE Storage *	operator-> ()

__INLINE const Storage *	operator-> () const

__INLINE Storage &	self ()

__INLINE const Storage &	self () const

virtual	~Storage ()

__INLINE real &	Real (const Tag &tag) const

__INLINE integer &	Integer (const Tag &tag) const

__INLINE bulk &	Bulk (const Tag &tag) const

__INLINE reference &	Reference (const Tag &tag) const

__INLINE remote_reference &	RemoteReference (const Tag &tag) const

__INLINE real_array	RealArray (const Tag &tag) const

__INLINE integer_array	IntegerArray (const Tag &tag) const

__INLINE bulk_array	BulkArray (const Tag &tag) const

__INLINE reference_array	ReferenceArray (const Tag &tag) const

__INLINE remote_reference_array	RemoteReferenceArray (const Tag &tag) const

__INLINE real_array	RealArrayDF (const Tag &tag) const

__INLINE integer_array	IntegerArrayDF (const Tag &tag) const

__INLINE bulk_array	BulkArrayDF (const Tag &tag) const

__INLINE reference_array	ReferenceArrayDF (const Tag &tag) const

__INLINE remote_reference_array	RemoteReferenceArrayDF (const Tag &tag) const

__INLINE real &	RealDF (const Tag &tag) const

__INLINE integer &	IntegerDF (const Tag &tag) const

__INLINE bulk &	BulkDF (const Tag &tag) const

__INLINE reference &	ReferenceDF (const Tag &tag) const

__INLINE remote_reference &	RemoteReferenceDF (const Tag &tag) const

__INLINE real_array	RealArrayDV (const Tag &tag) const

__INLINE integer_array	IntegerArrayDV (const Tag &tag) const

__INLINE bulk_array	BulkArrayDV (const Tag &tag) const

__INLINE reference_array	ReferenceArrayDV (const Tag &tag) const

__INLINE remote_reference_array	RemoteReferenceArrayDV (const Tag &tag) const

__INLINE real &	RealDV (const Tag &tag) const

__INLINE integer &	IntegerDV (const Tag &tag) const

__INLINE bulk &	BulkDV (const Tag &tag) const

__INLINE reference &	ReferenceDV (const Tag &tag) const

__INLINE remote_reference &	RemoteReferenceDV (const Tag &tag) const

__INLINE var &	Variable (const Tag &tag) const
	Retrieve variable reference associated with Tag. More...

__INLINE var &	VariableDF (const Tag &tag) const

__INLINE var &	VariableDV (const Tag &tag) const

__INLINE var_array	VariableArray (const Tag &tag) const
	Retrieve array of variables associated with Tag. More...

__INLINE var_array	VariableArrayDF (const Tag &tag) const

__INLINE var_array	VariableArrayDV (const Tag &tag) const

__INLINE INMOST_DATA_ENUM_TYPE	GetDataSize (const Tag &tag) const

__INLINE INMOST_DATA_ENUM_TYPE	GetDataCapacity (const Tag &tag) const

__INLINE void	SetDataSize (const Tag &tag, INMOST_DATA_ENUM_TYPE new_size) const

__INLINE void	GetData (const Tag &tag, INMOST_DATA_ENUM_TYPE shift, INMOST_DATA_ENUM_TYPE size, void *data) const

__INLINE void	SetData (const Tag &tag, INMOST_DATA_ENUM_TYPE shift, INMOST_DATA_ENUM_TYPE size, const void *data) const

__INLINE void	DelData (const Tag &tag) const

__INLINE void	DelSparseData (const Tag &tag) const
	Deallocates space allocated for sparse data, frees variable array if necessary. More...

__INLINE void	DelDenseData (const Tag &tag) const
	Frees variable array or fills field with zeroes. More...

__INLINE bool	HaveData (const Tag &tag) const
	Check if any data is associated with Tag. More...

__INLINE ElementType	GetElementType () const

__INLINE integer	GetElementNum () const

__INLINE void	SetMarker (MarkerType n) const

__INLINE bool	GetMarker (MarkerType n) const

__INLINE void	RemMarker (MarkerType n) const

__INLINE void	SetPrivateMarker (MarkerType n) const

__INLINE bool	GetPrivateMarker (MarkerType n) const

__INLINE void	RemPrivateMarker (MarkerType n) const

__INLINE void	ClearMarkerSpace () const

__INLINE void	GetMarkerSpace (bulk copy[MarkerFields]) const

__INLINE void	SetMarkerSpace (bulk source[MarkerFields]) const

__INLINE integer	LocalID () const

__INLINE integer	DataLocalID () const

__INLINE bool	isValid () const

__INLINE Mesh *	GetMeshLink () const

__INLINE HandleType	GetHandle () const

__INLINE Element	getAsElement () const

__INLINE Node	getAsNode () const

__INLINE Edge	getAsEdge () const

__INLINE Face	getAsFace () const

__INLINE Cell	getAsCell () const

__INLINE ElementSet	getAsSet () const

Static Public Member Functions
static Face	UniteFaces (ElementArray< Face > &faces, MarkerType del_protect)

static bool	TestUniteFaces (const ElementArray< Face > &faces, MarkerType del_protect)

static ElementArray< Face >	SplitFace (Face face, const ElementArray< Edge > &edges, MarkerType del_protect)

static bool	TestSplitFace (Face face, const ElementArray< Edge > &edges, MarkerType del_protect)

Static Public Member Functions inherited from INMOST::Element
static const char *	GeometricTypeName (GeometricType t)

static integer	GetGeometricDimension (GeometricType m_type)

static const char *	StatusName (Status s)

static bool	CheckConnectivity (Mesh *m)

Additional Inherited Members
Public Types inherited from INMOST::Element
typedef INMOST_DATA_BULK_TYPE	GeometricType

typedef INMOST_DATA_BULK_TYPE	Status

typedef inner_reference_array	adj_type

typedef adj_type::iterator	adj_iterator

typedef adj_type::const_iterator	const_adj_iterator

typedef adj_type::reverse_iterator	adj_reverse_iterator

typedef adj_type::const_reverse_iterator	const_adj_reverse_iterator

Public Types inherited from INMOST::Storage
typedef INMOST_DATA_REAL_TYPE	real
	Storage type for representing real values. More...

typedef INMOST_DATA_INTEGER_TYPE	integer
	Storage type for representing integer values. More...

typedef INMOST_DATA_BULK_TYPE	bulk
	Storage type for representing one byte of abstact data. More...

typedef INMOST_DATA_ENUM_TYPE	enumerator
	type for representing unsigned integer values. More...

typedef HandleType	reference
	Storage type for representing references to Element. More...

typedef RemoteHandleType	remote_reference
	Storage type for representing references to Element in another Mesh. More...

typedef shell< real >	real_array
	Storage type for representing arrays of real values. More...

typedef shell< integer >	integer_array
	Storage type for representing arrays of integer values. More...

typedef shell< bulk >	bulk_array
	Storage type for representing abstact data as a series of bytes. More...

typedef variable	var
	Storage type for representing real value with vector of variations. More...

typedef shell< variable >	var_array
	Storage type for representing array of values with vectors of variations. More...

Static Public Attributes inherited from INMOST::Element
static const GeometricType	Unset = 0

static const GeometricType	Vertex = 1

static const GeometricType	Line = 2

static const GeometricType	MultiLine = 3

static const GeometricType	Tri = 4

static const GeometricType	Quad = 5

static const GeometricType	Polygon = 6

static const GeometricType	MultiPolygon = 7

static const GeometricType	Tet = 8

static const GeometricType	Hex = 9

static const GeometricType	Prism = 10

static const GeometricType	Pyramid = 11

static const GeometricType	Polyhedron = 12

static const GeometricType	Set = 253

static const GeometricType	MeshPart = 254

static const GeometricType	MaxType = 255

static const Status	Owned = 1

static const Status	Shared = 2

static const Status	Ghost = 4

static const Status	Any = 0

Protected Member Functions inherited from INMOST::Element
void	SetGeometricType (GeometricType t)

Protected Attributes inherited from INMOST::Storage
HandleType	handle

HandleType *	handle_link

Detailed Description

An interface for elements of type FACE.

This interface carry the link to the mesh and the element's handle that represents position of the element's data in the mesh.

Interface provides some operations that can be done uniquely on the object of class Element for which Element::GetElementType retruns FACE.

For the basic set of operations on all of the elements check class Element.

For the basic set of operations on the data of the element check class Storage.

You can obtain object of class Face from Mesh::iteratorFace, in this case obtained object is always valid. Also you can get it through Mesh::FaceByLocalID, check with Element::isValid to see whether you have obtained a valid object. You can convert an object of class Element into an object of class Face by Element::getAsFace. In debug mode it will internally check that the element is of type FACE. You may compose an object of class Face by using constructor and specifing pointer to the mesh and providing element's handle. You can make a handle with ComposeHandle(FACE,local_id) function.

Definition at line 550 of file inmost_mesh.h.

Constructor & Destructor Documentation

INMOST::Face::Face ( )

inline

Definition at line 553 of file inmost_mesh.h.

INMOST::Face::Face ( const Face & other )

inline

Definition at line 554 of file inmost_mesh.h.

INMOST::Face::Face	(	Mesh *	m,
		HandleType	h
	)

inline

Definition at line 555 of file inmost_mesh.h.

INMOST::Face::Face	(	Mesh *	m,
		HandleType *	h
	)

inline

Definition at line 556 of file inmost_mesh.h.

Member Function Documentation

Storage::real INMOST::Face::Area ( ) const

Cell INMOST::Face::BackCell ( ) const

Retrieve the cell for which the normal points outwards.

Warning: Depending on the grid construction the normal may incorrectly point inwards. You can resolve this situation by Face::FixNormalOrientation.

Returns: the cell for which normal points outwards.

See Also: Face::FixNormalOrientation

bool INMOST::Face::CheckEdgeOrder ( ) const

bool INMOST::Face::CheckNormalOrientation ( ) const

bool INMOST::Face::Closure ( ) const

bool INMOST::Face::FaceOrientedOutside ( Cell c ) const

bool INMOST::Face::FixEdgeOrder ( ) const

bool INMOST::Face::FixNormalOrientation ( ) const

Cell INMOST::Face::FrontCell ( ) const

Retrieve the cell for which the normal points inwards.

Warning: Depending on the grid construction the normal may incorrectly point outwards. You can resolve this situation by Face::FixNormalOrientation.

Returns: the cell for which normal points inwards.

See Also: Face::FixNormalOrientation

Node INMOST::Face::getBeg ( ) const

ElementArray<Cell> INMOST::Face::getCells ( ) const

virtual

Return all the cells of the element.

For a node returns unordered set of cells.

For an edge returns unordered set of cells.

For a face returns a pair of cells. In the case Face::CheckNormalOrientation returns true then the normal points from the first cell to the second and in oppisite direction otherwise.

For a cell returns itself.

Returns: array of elements

See Also: Face::FaceOrientedOutside

Reimplemented from INMOST::Element.

ElementArray<Cell> INMOST::Face::getCells	(	MarkerType	mask,
		bool	invert_mask = `false`
	)		const

virtual

Reimplemented from INMOST::Element.

ElementArray<Edge> INMOST::Face::getEdges ( ) const

virtual

Retrieve all the edges of the element.

For a node returns unordered set of edges.

For an edge returns itself.

For a face returns ordered set of edges.

For a cell returns unordered set of edges.

Returns: array of elements

Reimplemented from INMOST::Element.

ElementArray<Edge> INMOST::Face::getEdges	(	MarkerType	mask,
		bool	invert_mask = `false`
	)		const

virtual

Reimplemented from INMOST::Element.

Node INMOST::Face::getEnd ( ) const

ElementArray<Node> INMOST::Face::getNodes ( ) const

virtual

Retrieve all the nodes of the element.

For a node returns itself.

For an edge returns ordered pair of nodes. The order of nodes in the edge is preserved from the first construction.

For a face returns ordered set of nodes. In the case Face::CheckNormalOrientation returns true the order of nodes will follow right hand side rule with respect to normal vector, otherwise it follows left hand side rule with respect to normal vector.

For a cell returns the same order that was provided through suggest_nodes_oreder in Mesh::CreateCell. In the case suggest_nodes_order was not provided, the order of nodes follows VTK format for known types of elements such as Element::Tet, Element::Prism, Element::Hex, Element::Pyramid. For a general polyhedron the order is unspecified.

Returns: array of elements

See Also: Face::CheckNormalOrientation; Face::FaceOrientedOutside

Reimplemented from INMOST::Element.

ElementArray<Node> INMOST::Face::getNodes	(	MarkerType	mask,
		bool	invert_mask = `false`
	)		const

virtual

Reimplemented from INMOST::Element.

void INMOST::Face::Normal ( real * nrm ) const

Face* INMOST::Face::operator-> ( )

inline

Definition at line 558 of file inmost_mesh.h.

const Face* INMOST::Face::operator-> ( ) const

inline

Definition at line 559 of file inmost_mesh.h.

Face& INMOST::Face::operator= ( Face const & other )

inline

Definition at line 557 of file inmost_mesh.h.

Here is the call graph for this function:

void INMOST::Face::OrientedNormal	(	Cell	c,
		real *	nrm
	)		const

void INMOST::Face::OrientedUnitNormal	(	Cell	c,
		real *	nrm
	)		const

void INMOST::Face::ReorderEdges ( ) const

Face& INMOST::Face::self ( )

inline

Definition at line 560 of file inmost_mesh.h.

const Face& INMOST::Face::self ( ) const

inline

Definition at line 561 of file inmost_mesh.h.

static ElementArray<Face> INMOST::Face::SplitFace	(	Face	face,
		const ElementArray< Edge > &	edges,
		MarkerType	del_protect
	)

static

void INMOST::Face::SwapCells ( )

static bool INMOST::Face::TestSplitFace	(	Face	face,
		const ElementArray< Edge > &	edges,
		MarkerType	del_protect
	)

static

static bool INMOST::Face::TestUniteFaces	(	const ElementArray< Face > &	faces,
		MarkerType	del_protect
	)

static

static Face INMOST::Face::UniteFaces	(	ElementArray< Face > &	faces,
		MarkerType	del_protect
	)

static

void INMOST::Face::UnitNormal ( real * nrm ) const

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

INMOST.lib/Source/Headers/inmost_mesh.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation