RefinementSelectors::OptimumSelector::Cand Struct Reference

A candidate. More...

#include <optimum_selector.h>

List of all members.

Public Member Functions
	Cand ()
	A default constructor.
	Cand (const int split, const int order_elems[4])
	Constructor.
	Cand (const int split, const int order_elem0, const int order_elem1=0, const int order_elem2=0, const int order_elem3=0)
	Constructor.
int	get_num_elems () const
	Returns a number of elements of a candidate.
Public Attributes
double	error
	An error of this candidate.
int	dofs
	An estimated number of DOFs.
int	split
	A refinement, see the enum RefinementType.
int	p [4]
	Encoded orders of sons, see H2D_MAKE_QUAD_ORDER. In a case of a triangle, the vertical order is equal to the horizontal one.
double	score
	A score of a candidate: the higher the better. If zero, the score is not valid and a candidate should be ignored. Evaluated in OptimumSelector::select_best_candidate.
Friends
H2D_API std::ostream &	operator<< (std::ostream &stream, const Cand &cand)
	Operator. Flushes contents of a candidate to a string stream. Useful for debug messages.

---

Detailed Description

A candidate.

---

Constructor & Destructor Documentation

RefinementSelectors::OptimumSelector::Cand::Cand

(

)

[inline]

A default constructor.

RefinementSelectors::OptimumSelector::Cand::Cand	(	const int	split,
		const int	order_elems[4]
	)			[inline]

Constructor.

Parameters:

[in]	split	A refinement, see the enum RefinementTypes.
[in]	order_elems	Encoded orders for all element of candidate. If triangle, a vertical order has to be equal to the horizontal one. Unused elements of the array can be ignored.

RefinementSelectors::OptimumSelector::Cand::Cand	(	const int	split,
		const int	order_elem0,
		const int	order_elem1 = 0,
		const int	order_elem2 = 0,
		const int	order_elem3 = 0
	)			[inline]

Constructor.

Parameters:

[in]	split	A refinement, see the enum RefinementTypes.
[in]	order_elem0	Encoded order of the first element of the candidate. If triangle, a vertical order has to be equal to the horizontal one.
[in]	order_elem1	Encoded order of the second element of the candidate, if any. If triangle, a vertical order has to be equal to the horizontal one.
[in]	order_elem2	Encoded order of the third element of the candidate, if any. If triangle, a vertical order has to be equal to the horizontal one.
[in]	order_elem3	Encoded order of the fourth element of the candidate, if any. If triangle, a vertical order has to be equal to the horizontal one.

---

Member Function Documentation

int RefinementSelectors::OptimumSelector::Cand::get_num_elems

(

)

const [inline]

Returns a number of elements of a candidate.

Returns:

A number of elements of a candidate.

---

Friends And Related Function Documentation

H2D_API std::ostream& operator<<	(	std::ostream &	stream,
		const Cand &	cand
	)			[friend]

Operator. Flushes contents of a candidate to a string stream. Useful for debug messages.

---

Member Data Documentation

int RefinementSelectors::OptimumSelector::Cand::dofs

An estimated number of DOFs.

double RefinementSelectors::OptimumSelector::Cand::error

An error of this candidate.

int RefinementSelectors::OptimumSelector::Cand::p[4]

Encoded orders of sons, see H2D_MAKE_QUAD_ORDER. In a case of a triangle, the vertical order is equal to the horizontal one.

double RefinementSelectors::OptimumSelector::Cand::score

A score of a candidate: the higher the better. If zero, the score is not valid and a candidate should be ignored. Evaluated in OptimumSelector::select_best_candidate.

int RefinementSelectors::OptimumSelector::Cand::split

A refinement, see the enum RefinementType.

---

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

• /var/www2/hermes2d/hermes2d/src/ref_selectors/optimum_selector.h