Global functions to build Bare Items.

Detailed Description

Functions
std::pair< BareEdge, bool >	Feel::makeBareEdge (size_type const i, size_type const j)
	It creates a BareEdge end returns the orientation of the created edge with respect to the given data. More...
std::pair< BareFace, bool >	Feel::makeBareFace (size_type const i, size_type const j, size_type const k)
	It creates Bare Face objects from three Point size_type's. More...
std::pair< BareFace, bool >	Feel::makeBareFace (size_type const i, size_type const j, size_type const k, size_type const l)
	It creates Bare Face objects from four Point size_type's. More...
BareEdge	Feel::setBareEdge (size_type const i, size_type const j)
	It creates a BareEdge, ignoring orientation. More...
BareEdge	Feel::setBareEdgeNo (size_type const i, size_type const j)
	It creates a non-standard BareEdge. More...

Function Documentation

std::pair<BareEdge, bool> Feel::makeBareEdge ( size_type const  i, size_type const  j  )

inline

It creates a BareEdge end returns the orientation of the created edge with respect to the given data.

Returns

is false if orientation has been changed.

Parameters

i	is a Point size_type
j	is a Point size_type

The BareEdge that will be built is the one passing by i and j. The orientation is i->j if the returned parameter is a true.

Precondition

i and j >0, i!=j

std::pair<BareFace, bool> Feel::makeBareFace	(	size_type const	i,
		size_type const	j,
		size_type const	k
	)

It creates Bare Face objects from three Point size_type's.

Returns

bool is false if orientation has been changed.

Parameters

i	is a Point size_type
j	is a Point size_type
k	is a Point size_type

To be used for triangular faces.

Precondition

i, j and k >0. i!=j!=k

Parameters

bool	is false if orientation has been changed.
i	is a Point size_type
j	is a Point size_type
k	is a Point size_type

To be used for triangular faces.

Precondition

i, j and k >0. i!=j!=k

std::pair<BareFace, bool> Feel::makeBareFace	(	size_type const	i,
		size_type const	j,
		size_type const	k,
		size_type const	l
	)

It creates Bare Face objects from four Point size_type's.

Returns

is false if orientation has been changed.

Parameters

i	is a Point size_type
j	is a Point size_type
k	is a Point size_type
l	is a Point size_type

Precondition

i, j, k and l >0. i!=j!=k!=l

To be used with Quad faces.

Remarks

For quad faces the construction process is more complex. We start from the smallest vertex and we take the first three vertices in the sequence. We then procede as for the triangles.

Parameters

bool	is false if orientation has been changed.
i	is a Point size_type
j	is a Point size_type
k	is a Point size_type
l	is a Point size_type

To be used for triangular faces.

Precondition

i, j and k >0. i!=j!=k

References Feel::makeBareFace().

BareEdge Feel::setBareEdge ( size_type const  i, size_type const  j  )

inline

It creates a BareEdge, ignoring orientation.

Parameters

i	is a Point size_type
j	is a Point size_type The BareEdge that will be built is the one passing by i and j A lighter version of MakeBareEdge, to be used if orientation flag is not needed;

Precondition

i and j >0, i!=j

References Feel::BareEdge::first, and Feel::BareEdge::second.

BareEdge Feel::setBareEdgeNo ( size_type const  i, size_type const  j  )

inline

It creates a non-standard BareEdge.

Parameters

i	is a Point size_type
j	is a Point size_type

Precondition

i and j >0 Yet another lighter version of MakeBareEdge, without orientation, To be used for non-oriented graphs.

Warning

It produces a BareEdge which does not comply with the invariant of the class (first < second). It must be used only if the BareEdge class is NOT used to uniquely identify edges.